From: Johan Hedberg <johan.hedberg@xxxxxxxxx>
---
This was formerly known as "doc: Add initial 6LoWPAN API definition".
It now has a more generic name so that other Networking profiles could
potentially be included behind the same channel in the future. I've
skipped event code 0x03 ("HW Error") since we couldn't reach concensus
there. So 0x03 is effectively a "reserved" value for now.
Makefile.am | 2 +-
doc/network-mgmt-api.txt | 326 +++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 327 insertions(+), 1 deletion(-)
create mode 100644 doc/network-mgmt-api.txt
diff --git a/Makefile.am b/Makefile.am
index 76d17239783f..d322117dabec 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -243,7 +243,7 @@ EXTRA_DIST += doc/assigned-numbers.txt doc/supported-features.txt \
doc/test-runner.txt \
doc/settings-storage.txt
-EXTRA_DIST += doc/mgmt-api.txt \
+EXTRA_DIST += doc/mgmt-api.txt doc/network-mgmt-api.txt \
doc/adapter-api.txt doc/device-api.txt \
doc/agent-api.txt doc/profile-api.txt \
doc/network-api.txt doc/media-api.txt \
diff --git a/doc/network-mgmt-api.txt b/doc/network-mgmt-api.txt
new file mode 100644
index 000000000000..29e506c8283b
--- /dev/null
+++ b/doc/network-mgmt-api.txt
@@ -0,0 +1,326 @@
+Network Management API
+**********************
+
+Copyright (C) 2015 Intel Corporation
+
+
+Overview
+========
+
+The Network Management API follows largely the same principles as the main
+Bluetooth Management API described in mgmt-api.txt. The main difference is
+a separate namespace for command and event codes, distinguished by using
+HCI_CHANNEL_NETWORK rather than HCI_CHANNEL_CONTROL when creating the mgmt
+socket.
+
+
+Read Version Information Command
+================================
+
+ Command Code: 0x0001
+ Controller Index: <non-controller>
+ Command Parameters:
+ Return Parameters: Version (1 Octets)
+ Revision (2 Octets)
+
+ This command returns the Network Management version and
+ revision. In addition to being informational the information can
+ be used to determine whether certain behavior has changed or
+ bugs fixed when interacting with the kernel.
+
+ This command generates a Command Complete event on success or
+ a Command Status event on failure.
+
+
+Read Supported Commands Command
+===============================
+
+ Command Code: 0x0002
+ Controller Index: <non-controller>
+ Command Parameters:
+ Return Parameters: Num_Of_Commands (2 Octets)
+ Num_Of_Events (2 Octets)
+ Command1 (2 Octets)
+ Command2 (2 Octets)
+ ...
+ Event1 (2 Octets)
+ Event2 (2 Octets)
+ ...
+
+ This command returns the list of supported Network commands
+ and events.
+
+ The commands Read Version Information and Read Supported
+ Commands are not included in this list. Both commands are always
+ supported and mandatory.
+
+ The events Command Status and Command Complete are not included
+ in this list. Both are implicit and mandatory.
+
+ This command generates a Command Complete event on success or
+ a Command Status event on failure.
+
+
+Read Controller Index List Command
+==================================
+
+ Command Code: 0x0003
+ Controller Index: <non-controller>
+ Command Parameters:
+ Return Parameters: Num_Controllers (2 Octets)
+ Controller_Index[i] (2 Octets)
+
+ This command returns the list of currently known controllers
+ that can be used for Network connections. Controllers added or
+ removed after calling this command can be monitored using the
+ Index Added and Index Removed events.
+
+ This command generates a Command Complete event on success or
+ a Command Status event on failure.
+
+
+Read Controller Information Command
+===================================
+
+ Command Code: 0x0004
+ Controller Index: <controller id>
+ Command Parameters:
+ Return Parameters: Address (6 Octets)
+ Address_Type (6 Octets)
+ Supported_Settings (4 Octets)
+ Current_Settings (4 Octets)
+ 6LoWPAN_Interface_Index (4 Octets)
+
+ This command is used to retreive the current state and basic
+ information of a controller. It is typically used right after
+ getting the response to the Read Controller Index List command
+ or an Index Added event.
+
+ Current_Settings and Supported_Settings is a bitmask with
+ currently the following available bits:
+
+ 0 6LoWPAN
+ 1 6LoWPAN Server (Node)
+
+ The 6LoWPAN_Interface_Index parameter value is only valid if the
+ 6LoWPAN settings bit is set in the Current_Settings, otherwise
+ it should be ignored.
+
+ This command generates a Command Complete event on success or
+ a Command Status event on failure.
+
+ Possible errors: Invalid Parameters
+ Invalid Index
+
+
+Connect 6LoWPAN Command
+=======================
+
+ Command Code: 0x0005
+ Controller Index: <controller id>
+ Command Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+ Return Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+
+ This command is used to connect to a remote 6LoWPAN Node.
+
+ Possible values for the Address_Type parameter:
+ 1 LE Public
+ 2 LE Random
+
+ This command generates a Command Complete event on success
+ or failure.
+
+ Possible errors: Busy
+ Refused
+ Invalid Parameters
+ Not Powered
+ Invalid Index
+
+
+Disconnect 6LoWPAN Command
+==========================
+
+ Command Code: 0x0006
+ Controller Index: <controller id>
+ Command Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+ Return Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+
+ This command is used to disconnect from a remote 6LoWPAN device.
+
+ Possible values for the Address_Type parameter:
+ 1 LE Public
+ 2 LE Random
+
+ This command generates a Command Complete event on success
+ or failure.
+
+ Possible errors: Busy
+ Not Connected
+ Invalid Parameters
+ Not Powered
+ Invalid Index
+
+
+Get 6LoWPAN Connections Command
+===============================
+
+ Command Code: 0x0007
+ Controller Index: <controller id>
+ Command Parameters:
+ Return Parameters: Connection_Count (2 Octets)
+ Address1 {
+ Address (6 Octets)
+ Address_Type (1 Octet)
+ }
+ Address2 { }
+ ...
+
+ This command is used to retrieve a list of currently connected
+ 6LoWPAN devices.
+
+ Possible values for the Address_Type parameter:
+ 1 LE Public
+ 2 LE Random
+
+ For devices using resolvable random addresses with a known
+ identity resolving key, the Address and Address_Type will
+ contain the identity information.
+
+ This command can only be used when the controller is powered.
+
+ This command generates a Command Complete event on success or
+ a Command Status event on failure.
+
+ Possible errors: Invalid Parameters
+ Not Powered
+ Invalid Index
+
+
+Enable 6LoWPAN Server Command
+=============================
+
+ Command Code: 0x0008
+ Controller Index: <controller id>
+ Command Parameters: Enable (1 Octet)
+ Return Parameters: Current_Settings (4 Octets)
+
+ This command is used start a 6LoWPAN Server (Node rols) on a
+ specified controller.
+
+ This command generates a Command Complete event on success or
+ a Command Status event on failure.
+
+ Possible errors: Busy
+ Invalid Index
+
+
+Command Complete Event
+======================
+
+ Event Code: 0x0001
+ Controller Index: <controller id> or <non-controller>
+ Event Parameters: Command_Opcode (2 Octets)
+ Status (1 Octet)
+ Return_Parameters
+
+ This event is an indication that a command has completed. The
+ fixed set of parameters includes the opcode to identify the
+ command that completed as well as a status value to indicate
+ success or failure. The rest of the parameters are command
+ specific and documented in the section for each command
+ separately.
+
+
+Command Status Event
+====================
+
+ Event Code: 0x0002
+ Controller Index: <controller id> or <non-controller>
+ Event Parameters: Command_Opcode (2 Octets)
+ Status (1 Octet)
+
+ The command status event is used to indicate an early status for
+ a pending command. In the case that the status indicates failure
+ (anything else except success status) this also means that the
+ command has finished executing.
+
+
+Index Added Event
+=================
+
+ Event Code: 0x0004
+ Controller Index: <controller id>
+ Event Parameters:
+
+ This event indicates that a new Networking capable controller
+ has been added to the system. It is usually followed by a Read
+ Controller Information command.
+
+
+Index Removed Event
+===================
+
+ Event Code: 0x0005
+ Controller Index: <controller id>
+ Event Parameters:
+
+ This event indicates that a Network-capable controller has been
+ removed from the system.
+
+
+New Settings Event
+==================
+
+ Event Code: 0x0006
+ Controller Index: <controller id>
+ Event Parameters: Current_Settings (4 Octets)
+
+ This event indicates that one or more of the settings for a
+ controller has changed.
+
+
+6LoWPAN Connected Event
+=======================
+
+ Event Code: 0x0007
+ Controller Index: <controller id>
+ Event Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+
+ This event indicates that a successful 6LoWPAN connection has
+ been created to the remote device.
+
+ For devices using resolvable random addresses with a known
+ identity resolving key, the Address and Address_Type will
+ contain the identity information.
+
+
+6LoWPAN Disconnected Event
+==========================
+
+ Event Code: 0x0008
+ Controller Index: <controller id>
+ Event Parameters: Address (6 Octets)
+ Address_Type (1 Octet)
+ Reason (1 Octet)
+
+ This event indicates that the 6LoWPAN connection was lost to a
+ remote device.
+
+ Possible values for the Address_Type parameter:
+ 1 LE Public
+ 2 LE Random
+
+ For devices using resolvable random addresses with a known
+ identity resolving key, the Address and Address_Type will
+ contain the identity information.
+
+ Possible values for the Reason parameter:
+ 0 Unspecified
+ 1 Connection timeout
+ 2 Connection terminated by local host
+ 3 Connection terminated by remote host
--
2.4.3
--
To unsubscribe from this list: send the line "unsubscribe linux-bluetooth" in
