diff --git a/nimble/doc/hci_vendor.md b/nimble/doc/hci_vendor.md new file mode 100644 index 000000000..ad9d465e7 --- /dev/null +++ b/nimble/doc/hci_vendor.md @@ -0,0 +1,336 @@ + + + +Nimble Vendor Supported Commands +================================ + +*OGF = 0x003F* + + +Read Static Address Command +--------------------------- + +Read the static random address assigned to the controller + +| Command | OCF | Params |Return params | +|-------------------|--------|------------|--------------| +| Read_Addr | 0x0001 | *none* | Static_Addr | + +
+Static_Addr + +| Value | Description | +|--------------------|-------------| +| 0xXXXXXXXXXXXX | Address | + +*Size: 6 octets* + + +Set Default Transmit Power +-------------------------- + +Set default transmit power level
+Selected TX power is returned
+Setting 0xFF restores controller setting to default
+ +| Command | OCF | Params | Return params | +|-------------------|--------|------------|---------------| +| Set_Tx_Pwr | 0x0002 | Tx_Pwr | Sel_Tx_Pwr | + +
+Tx_Pwr + +| Value | Description | +|----------------------------|------------------------| +| 0xXX | Desired TX Power Level | + +*Size: 1 octet* + +
+Sel_Tx_Pwr + +| Value | Description | +|------------------|------------------------------| +| 0xXX | Controller Selected TX power | + +*Size: 1 octet* + + +Configure Connection Strict Scheduling +-------------------------------------- + +Configure Connection Strict Scheduling + +| Command | OCF | Params | Return params | +|-------------------|--------|------------|---------------| +| CSS_Configure | 0x0003 | Slot_us | *none* | +| | | Num_Slots | | + +
+Slot_us + +| Value | Description | +|----------------------------|-----------------------| +| 0xXXXXXX | Slot duration in msec | + +*Size: 4 octets* + +
+Number_Of_Slots + +| Value | Description | +|----------------------------|------------------------| +| 0xXXXXXX | Number of period slots | + +*Size: 4 octets* + + +Connection strict scheduling enable +----------------------------------- + +Enable/Disable Connection Strict Scheduling + +| Command | OCF | Params | Return params | +|--------------|--------|--------------|---------------| +| CSS_Enable | 0x0004 |Enable/Disale | *none* | + + +
+Enable/Disable + +| Value | Description | +|----------------------------|--------------------| +| 0xXX | Enable/Disable CSS | + +*Size: 1 octet* + + +Connection Strict Scheduling - Select Next Slot +----------------------------------------------- + +Set next slot index for future connection + +| Command | OCF | Params | Return params | +|-------------------|--------|--------------|---------------| +| CSS_Set_Next_Slot | 0x0005 |Next_Slot_Idx | *none* | + + +
+Next_Slot_Idx + +| Value | Description | +|----------------------------|--------------| +| 0xXXXX | Next Slot ID | + +*Size: 2 octets* + + +Connection Strict Scheduling - Select Slot For Specific Connection +------------------------------------------------------------------ + +Set slot index for current connection + +| Command | OCF | Params | Return params | +|-------------------|--------|------------|---------------| +| CSS_Configure | 0x0006 | Conn_Hdl | *none* | +| | | Slot_Idx | | + +
+Conn_Hdl + +| Value | Description | +|----------------------------|-------------------| +| 0xXXXX | Connection Handle | + +*Size: 2 octets* + +
+Slot_Idx + +| Value | Description | +|----------------------------|-------------| +| 0xXXXX | Slot ID | + +*Size: 2 octets* + + +Connection Strict Scheduling - Read Connection Slot +--------------------------------------------------- + +Read current connection slot index + +| Command | OCF | Params | Return params | +|-------------------|--------|--------------|---------------| +| CSS_Set_Next_Slot | 0x0007 | Conn_Hdl | Conn_Hdl | +| | | | Slot_Idx | + +
+Conn_Hdl + +| Value | Description | +|----------------------------|-------------------| +| 0xXXXX | Connection Handle | + +*Size: 2 octets* + +
+Slot_Idx + +| Value | Description | +|--------------------|-------------| +| 0xXXXX | Slot_ID | +*Size: 2 octets* + + +Set Data Length +--------------- + +Change TX/RX values. +Waits for Data Length Changed event. + +| Command | OCF | Params | Return params | +|--------------|--------|-----------------|---------------| +| Set_Data_Len | 0x0008 | Conn_Hdl
| Conn_Hdl | +| | | Tx_Octets
| | +| | | Tx_Time
| | +| | | Rx_Octets
| | +| | | Rx_Time
| | + +
+Conn_Hdl + +| Value | Description | +|----------------------------|-------------------| +| 0xXXXX | Connection Handle | + +*Size: 2 octets* + +
+Tx_Octets + +| Value | Description | +|----------------------------|-----------------| +| 0xXXXX | Transmit octets | + +*Size: 2 octets* + +
+Tx_Time + +| Value | Description | +|----------------------------|-------------------| +| 0xXXXX | Transmission time | + +*Size: 2 octets* + +
+Rx_Octets + +| Value | Description | +|----------------------------|-----------------| +| 0xXXXX | Receiver octets | + +*Size: 2 octets* + +
+Rx_Time + +| Value | Description | +|----------------------------|---------------| +| 0xXXXX | Receiver time | + +*Size: 2 octets* + + +Set Antenna Location +-------------------- + +| Command | OCF | Params | Return params | +|---------------|--------|----------------|---------------| +| Set_Ant_Loc | 0x0009 | Ant_Loc | *none* | + + +
+Ant_Loc + +| Value | Description | +|----------------------------|------------------| +| 0xXX | Antenna location | + +*Size: 1 ocet* + + +Set Local Identity Resolving Key +-------------------------------- + +Set own address type & identity resolving key + +| Command | OCF | Params | Return params | +|-----------------|--------|---------------|---------------| +| Set_Local_IRK | 0x000A | Own_Addr_Type | *none* | +| | | IRK | | + +
+Rx_Time + +| Value | Description | +|----------------------------|---------------------| +| 0xXX | Device Address Type | + +*Size: 1 ocet* + +
+IRK + +| Value | Description | +|--------------------|------------------------| +| 0xXX(16) | Identity Resolving Key | + +*Size: 16 ocets* + + +Set Scan Configuration +---------------------- + +| Command | OCF | Params | Return params | +|-----------------|--------|---------------|---------------| +| Set_Scan_Cfg | 0x000B | Flags | *none* | +| | | Rssi_Tres | | + +
+Flags + +| Value | Description | +|----------------------------|-------------------------| +| 0x00000001
| No legacy advertising | +| 0x00000002 | No extended advertising | + +*Size: 4 octets* + +
+Rssi_Tres + +| Value | Description | +|----------------------------|---------------------| +| 0xXX | RSSI treshold value | + +*Size: 1 octet*