From patchwork Thu Apr 23 01:09:59 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miao-chen Chou X-Patchwork-Id: 11504813 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 0B17481 for ; Thu, 23 Apr 2020 01:10:07 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id D37B02074F for ; Thu, 23 Apr 2020 01:10:06 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=chromium.org header.i=@chromium.org header.b="jjSeojtV" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726234AbgDWBKG (ORCPT ); Wed, 22 Apr 2020 21:10:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60524 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1725846AbgDWBKF (ORCPT ); Wed, 22 Apr 2020 21:10:05 -0400 Received: from mail-pj1-x1044.google.com (mail-pj1-x1044.google.com [IPv6:2607:f8b0:4864:20::1044]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CF363C03C1AA for ; Wed, 22 Apr 2020 18:10:05 -0700 (PDT) Received: by mail-pj1-x1044.google.com with SMTP id y6so1700919pjc.4 for ; Wed, 22 Apr 2020 18:10:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=8r4B4QfH6JsmLMSc/RDjYDviSQ8QJBaUnJFCgEAW1Hg=; b=jjSeojtVm9CDqRW24AO5tr6qhyv83v+gkA5V8Lp/UmGGcJU8epYpUWDtRTrT8CUN9C 7expgx8mxOiLnNh6/RlUQZmNCkbBZqaeCKZyheK2zIgKauNcMyjCYlIujJ7eZ2DAkRPL nu91BvUkJmafinSwnhZS+Do7ywUtX5Ei0xSms= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=8r4B4QfH6JsmLMSc/RDjYDviSQ8QJBaUnJFCgEAW1Hg=; b=LkN5RWrpzX8w73oXqQ+iZG+4YYBninxY/7aV9bB1kgYM5/g4CU8D5ZNKa9F15r8rvm Y1w6Hmiv5hBBTnmY6DsE/saAebJMMN221qvJ/3Iy6HtsZSzZe9OJIG7dRbPanWlwIRGx JEmVrmtpYIvVWykJbJvC9EKzGR8aefEyau9XFK5QsyJFdYaktX8I106lVnky09GKtsMb hVgNViURks4tJ67S+TLuyN9eqTgj3IREOkRwhU1PyKBP6K9EPnG/Y5cgWlxTf0ACAiDD fC2ELMyavwPyio/WW3GkNd6femduWzLH3TMRMofXKPlv9Y/3CshxErSAWR/9ndf9KcCx ng9g== X-Gm-Message-State: AGi0PuYE4iOSSvCu0Y1eZJSJg6VIt/pbNUHjP6guM96KO1qGN3GgSbWP OLwJDyMzzS54bZ3IocnnEmrxZXy1aUo= X-Google-Smtp-Source: APiQypK4JH8EmnDDv42YQYRLTfXzgpg/FXVfwsROHekLQdbArX5p18hl8ZcUZVIViUcCsU1X0gpuvg== X-Received: by 2002:a17:90a:290f:: with SMTP id g15mr1531852pjd.93.1587604204674; Wed, 22 Apr 2020 18:10:04 -0700 (PDT) Received: from mcchou0.mtv.corp.google.com ([2620:15c:202:201:b46:ac84:1014:9555]) by smtp.gmail.com with ESMTPSA id o68sm753110pfb.206.2020.04.22.18.10.02 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 22 Apr 2020 18:10:03 -0700 (PDT) From: Miao-chen Chou To: Bluetooth Kernel Mailing List Cc: Alain Michaud , Marcel Holtmann , Yoni Shavit , Michael Sun , Luiz Augusto von Dentz , Miao-chen Chou Subject: [BlueZ PATCH v2] doc: Describe the new Advertisement Monitor support Date: Wed, 22 Apr 2020 18:09:59 -0700 Message-Id: <20200422180939.BlueZ.v2.1.If9f6be992cbaeaa35423de29da6db28675b35fcc@changeid> X-Mailer: git-send-email 2.24.1 MIME-Version: 1.0 Sender: linux-bluetooth-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org This describes the following commands and event. - Read Advertisement Monitor Features command - Add Advertisement Patterns Monitor command - Remove Advertisement Monitor command - Advertisement Monitor Added event - Advertisement Monitor Removed event Note that the content of a monitor can differ based on its type. For now we introduce only pattern-based monitor, so you may find that unlike the command of removing monitor(s), the Add command is tied to a specific type. --- Changes in v3: - Remove Advertisement Monitor can perform the removal of one monitor or all monitors. - Add Read Advertisement Monitor Features command. - Add Advertisement Monitor Added event and dvertisement Monitor Removed event. Changes in v2: - Combine commands to remove one monitor and remove all monitors. The refined command takes multiple handles and an extra field to indicate whether to remove all monitors. doc/mgmt-api.txt | 118 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt index 39f23c456..3cef3edbf 100644 --- a/doc/mgmt-api.txt +++ b/doc/mgmt-api.txt @@ -3138,6 +3138,102 @@ Read Security Information Command Invalid Index +Read Advertisement Monitor Features Command +=========================================== + + Command Code: 0x0049 + Controller Index: + Command Parameters: + Return Parameters: Supported_Features (4 octets) + Adopted_Features (4 octets) + + This command is used to read the advertisement monitor features supported + by the controller and stack. Supported_Features lists all related + features supported by the controller while Adopted_Features lists the + ones currently adopted by the stack. + + Supported_Features and Adopted_Features are bitmasks with currently the + following available bits: + + 1 Advertisement content monitoring based on Microsoft HCI + extension. + + +Add Advertisement Patterns Monitor Command +========================================= + + Command Code: 0x004A + Controller Index: + Command Parameters: Pattern_count (1 Octets) + Pattern1 { + AD_Data_Type (1 Octet) + Offset (1 Octet) + Length (1 Octet) + Value (variable length) + } + Pattern2 { } + ... + Return Parameters: Monitor_Handle (4 Octets) + + This command is used to add an advertisement monitor whose filtering + conditions are patterns. The kernel would track the number of registered + monitors to determine whether to perform LE scanning while there is + ongoing LE scanning for other intentions, such as auto-reconnection and + discovery session. If the controller supports advertisement filtering, + the kernel would offload the content filtering to the controller in + order to reduce power consumption; otherwise the kernel ignore the + content of the monitor. Note that if the there are more than one + patterns, OR logic would applied among patterns during filtering. In + other words, any advertisement matching at least one pattern in a given + monitor would be considered as a match. + + A pattern contain the following fields. + AD_Data_Type Advertising Data Type. The possible values are + defined in Core Specification Supplement. + Offset The start index where pattern matching shall be + performed with in the AD data. + Length The length of the pattern value in bytes. + Value The value of the pattern in bytes. + + Here is an example of a pattern. + { + 0x16, // Service Data - 16-bit UUID + 0x02, // Skip the UUID part. + 0x04, + {0x11, 0x22, 0x33, 0x44}, + } + + Possible errors: Failed + Busy + Invalid Parameters + + +Remove Advertisement Monitor Command +==================================== + + Command Code: 0x004B + Controller Index: + Command Parameters: Monitor_Handle (4 Octets) + Return Parameters: + + This command is used to remove advertisement monitor(s). The kernel + would remove the monitor(s) with Monitor_Index and update the LE + scanning. If the controller supports advertisement filtering and the + monitor(s) has been offloaded, the kernel would cancel the offloading; + otherwise the kernel takes no further actions other than removing the + monitor(s) from the list. + + Monitor_Handle can be the following values. + Value Operation + ------------------------- + 0x00000000 Removes all existing monitor(s) + 0x00000001 or greater Removes the monitor with that handle + + Possible errors: Failed + Busy + Invalid Index + + Command Complete Event ====================== @@ -4020,3 +4116,25 @@ PHY Configuration Changed Event one through which the change was triggered. Refer Get PHY Configuration command for PHYs parameter. + + +Advertisement Monitor Added Event +================================= + + Event Code: 0x0027 + Controller Index: + Event Parameters: Monitor_Handle (4 Octets) + + This event indicates that an advertisement monitor has been added using + the Add Advertisement Monitor command. + + +Advertisement Monitor Removed Event +=================================== + + Event Code: 0x0028 + Controller Index: + Event Parameters: Monitor_Handle (4 Octets) + + This event indicates that an advertisement monitor has been removed + using the Remove Advertisement Monitor command.