sergiotarxz/nuttx
sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update some comments.

Browse Source
This commit is contained in:
Gregory Nutt 2018-04-22 07:36:39 -06:00
parent 505f460b6b
commit f188b35707
2 changed files with 58 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
include/nuttx/wireless/bt_ioctl.h
View File

@ -341,36 +341,36 @@ struct bt_stats_s
struct btreq_s struct btreq_s
{ {
char btr_name[IFNAMSIZ]; /* Device name */ char btr_name[IFNAMSIZ]; /* IN: Device name */
union union
{ {
/* Bluetooth information used by most NetBSD IOCTL commands */ /* Bluetooth information used with informational query IOCTL commands */
struct struct
{ {
bt_addr_t btri_bdaddr; /* Device bdaddr */ bt_addr_t btri_bdaddr; /* IN/OUT: Device bdaddr */
uint16_t btri_flags; /* flags */ uint16_t btri_flags; /* OUT: flags */
uint16_t btri_num_cmd; /* # of free cmd buffers */ uint16_t btri_num_cmd; /* OUT: Number of free cmd buffers */
uint16_t btri_num_acl; /* # of free ACL buffers */ uint16_t btri_num_acl; /* OUT: Number of free ACL buffers */
uint16_t btri_num_sco; /* # of free SCO buffers */ uint16_t btri_num_sco; /* OUT: Number of free SCO buffers */
uint16_t btri_acl_mtu; /* ACL mtu */ uint16_t btri_acl_mtu; /* OUT: ACL mtu */
uint16_t btri_sco_mtu; /* SCO mtu */ uint16_t btri_sco_mtu; /* OUT: SCO mtu */
uint16_t btri_link_policy; /* Link Policy */ uint16_t btri_link_policy; /* OUT: Link Policy */
uint16_t btri_packet_type; /* Packet Type */ uint16_t btri_packet_type; /* OUT: Packet Type */
uint16_t btri_max_acl; /* max ACL buffers */ uint16_t btri_max_acl; /* OUT: max ACL buffers */
uint16_t btri_max_sco; /* max SCO buffers */ uint16_t btri_max_sco; /* OUT: max SCO buffers */
} btri; } btri;
/* Bluetooth Features */ /* Bluetooth Features */
struct struct
{ {
uint8_t btrf_page0[HCI_FEATURES_SIZE]; /* Basic */ uint8_t btrf_page0[HCI_FEATURES_SIZE]; /* OUT: Basic */
uint8_t btrf_page1[HCI_FEATURES_SIZE]; /* Extended page 1 */ uint8_t btrf_page1[HCI_FEATURES_SIZE]; /* OUT: Extended page 1 */
uint8_t btrf_page2[HCI_FEATURES_SIZE]; /* Extended page 2 */ uint8_t btrf_page2[HCI_FEATURES_SIZE]; /* OUT: Extended page 2 */
} btrf; } btrf;
struct bt_stats_s btrs; /* Unit statistics */ struct bt_stats_s btrs; /* OUT: Unit statistics */
/* Read-only data that accompanies the SIOCBTADVSTART IOCTL command. /* Read-only data that accompanies the SIOCBTADVSTART IOCTL command.
* Advertising types are defined in bt_hci.h. NOTE that btras_ad and * Advertising types are defined in bt_hci.h. NOTE that btras_ad and
@ -381,9 +381,9 @@ struct btreq_s
struct struct
{ {
uint8_t btras_advtype; /* Advertising type */ uint8_t btras_advtype; /* IN: Advertising type */
FAR struct bt_eir_s *btras_advad; /* Data for advertisement packets */ FAR struct bt_eir_s *btras_advad; /* IN: Data for advertisement packets */
FAR struct bt_eir_s *btras_advsd; /* Data for scan response packets */ FAR struct bt_eir_s *btras_advsd; /* IN: Data for scan response packets */
} btras; } btras;
/* NOTE: No additional data accompanies the SIOCBTADVSTOP */ /* NOTE: No additional data accompanies the SIOCBTADVSTOP */
@ -394,15 +394,15 @@ struct btreq_s
struct struct
{ {
bool btrss_dupenable; /* True: enable duplicate filtering */ bool btrss_dupenable; /* IN: True: enable duplicate filtering */
} btrss; } btrss;
/* Write-able data that accompanies the SIOCBTSCANGET IOCTL command */ /* Write-able data that accompanies the SIOCBTSCANGET IOCTL command */
struct struct
{ {
uint8_t brtsr_nrsp; /* Input: Max number of responses uint8_t brtsr_nrsp; /* IN: Max number of responses
* Return: Actual number of responses */ * OUT: Actual number of responses */
/* Reference to a beginning of an array in user memory in which to /* Reference to a beginning of an array in user memory in which to
* return the scan response data. The size of the array is * return the scan response data. The size of the array is
@ -418,15 +418,15 @@ struct btreq_s
struct struct
{ {
bt_addr_le_t btrse_secaddr; /* BLE address */ bt_addr_le_t btrse_secaddr; /* IN: BLE address */
enum bt_security_e btrse_seclevel; /* Security level */ enum bt_security_e btrse_seclevel; /* IN: Security level */
} btrse; } btrse;
/* Read-only data that accompanies SIOCBTEXCHANGE command */ /* Read-only data that accompanies SIOCBTEXCHANGE command */
struct struct
{ {
bt_addr_le_t btmx_expeer; /* Peer address for MTU exchange */ bt_addr_le_t btmx_expeer; /* IN: Peer address for MTU exchange */
} btmx; } btmx;
/* Write result that accompanies SIOCBTEXRESULT command */ /* Write result that accompanies SIOCBTEXRESULT command */
@ -437,20 +437,20 @@ struct btreq_s
struct struct
{ {
uint8_t btrds_dtype; /* Discovery type (see enum uint8_t btrds_dtype; /* IN: Discovery type (see enum
* bt_gatt_discover_e) */ * bt_gatt_discover_e) */
bt_addr_le_t btrds_dpeer; /* Peer address */ bt_addr_le_t btrds_dpeer; /* IN: Peer address */
uint16_t btrds_duuid16; /* Discover UUID type */ uint16_t btrds_duuid16; /* IN: Discover UUID type */
uint16_t btrds_dstart; /* Discover start handle */ uint16_t btrds_dstart; /* IN: Discover start handle */
uint16_t btrds_dend; /* Discover end handle */ uint16_t btrds_dend; /* IN: Discover end handle */
} btrds; } btrds;
/* Write-able structure that accompanies the SIOCBTDISCGET command. */ /* Write-able structure that accompanies the SIOCBTDISCGET command. */
struct struct
{ {
uint8_t btrdg_gnrsp; /* Input: Max number of responses uint8_t btrdg_gnrsp; /* IN: Max number of responses
* Return: Actual number of responses */ * OUT: Actual number of responses */
/* Reference to a beginning of an array in user memory in which to /* Reference to a beginning of an array in user memory in which to
* return the discovered data. The size of the array is btrdg_gnrsp. * return the discovered data. The size of the array is btrdg_gnrsp.
@ -463,9 +463,9 @@ struct btreq_s
struct struct
{ {
bt_addr_le_t btgrd_rdpeer; /* Peer address */ bt_addr_le_t btgrd_rdpeer; /* IN: Peer address */
uint8_t btgrd_rdnhandles; /* Number of handles in array */ uint8_t btgrd_rdnhandles; /* IN: Number of handles in array */
uint16_t btgrd_rdoffset; /* Offset (Only for read single) */ uint16_t btgrd_rdoffset; /* IN: Offset (Only for read single) */
uint16_t btgrd_rdhandles[HCI_GATT_MAXHANDLES]; uint16_t btgrd_rdhandles[HCI_GATT_MAXHANDLES];
} btgrd; } btgrd;
@ -473,11 +473,11 @@ struct btreq_s
struct struct
{ {
bool btgrr_rdpending; /* True: Read not yet complete */ bool btgrr_rdpending; /* OUT: True: Read not yet complete */
uint8_t btgrr_rdresult; /* Result of the read */ uint8_t btgrr_rdresult; /* OUT: Result of the read */
uint8_t btgrr_rdsize; /* Input: Sizeof rddata[] uint8_t btgrr_rdsize; /* IN: Sizeof rddata[]
* Output: Number of valid bytes */ * OUT: Number of valid bytes */
FAR uint8_t *btgrr_rddata; /* Values returned by read */ FAR uint8_t *btgrr_rddata; /* OUT: Values returned by read */
} btgrr; } btgrr;
/* Read-only data that accompanies the SIOCBTGATTWR command. /* Read-only data that accompanies the SIOCBTGATTWR command.
@ -487,15 +487,15 @@ struct btreq_s
struct struct
{ {
bt_addr_le_t btgwr_wrpeer; /* Peer address */ bt_addr_le_t btgwr_wrpeer; /* IN: Peer address */
uint8_t btgwr_wrnbytes; /* Number of bytes to write */ uint8_t btgwr_wrnbytes; /* IN: Number of bytes to write */
uint16_t btgwr_wrhandle; /* GATT handle */ uint16_t btgwr_wrhandle; /* IN: GATT handle */
FAR uint8_t btgwr_wrdata[HCI_GATTWR_DATA]; /* Data to be written */ FAR uint8_t btgwr_wrdata[HCI_GATTWR_DATA]; /* IN: Data to be written */
} btgwr; } btgwr;
/* Write result that accompanies SIOCBTGATTWRGET command */ /* Write result that accompanies SIOCBTGATTWRGET command */
struct bt_result_s btgwrr; struct bt_result_s btgwrr; /* OUT: Result of the write */
} btru; } btru;
}; };

17
wireless/bluetooth/bt_ioctl.c
View File

@ -107,17 +107,22 @@ struct btnet_rdstate_s
****************************************************************************/ ****************************************************************************/
/* At present only a single Bluetooth device is supported. So we can simply /* At present only a single Bluetooth device is supported. So we can simply
* maintain the scan, MTU exchange, and discovery states as globals. * maintain the pending scan, discovery, MTU exchange, read and write states
* as globals.
* *
* NOTE: This limits to a single Bluetooth device with one concurrent scan * NOTE: This limits to a single Bluetooth device with one concurrent scan
* action, one concurrent MTU exchange, and one concurrent discovery action. * action, one concurrent MTU exchange, one concurrent discovery action,
* etc.
* *
* REVISIT: A fix might be to (1) allocate instances on each IOCTL command * REVISIT: A fix might be to (1) allocate instances on each IOCTL command
* the starts an operation, keeping the allocated structures in a list. (2) * the starts an operation, keeping the allocated structures in a list. (2)
* Return a reference number with each such command. That reference number * Return a reference number with each such command that starts an
* would then be used in each IOCTL command that gets the result of the * operation. That reference number would then be used in each IOCTL
* previously requested data. (3) The allocated instance would be freed * command that gets the result of the requested operation. (3) The
* wither (1) it is empty or (2) it has expired without being harvested. * allocated instance would be freed when either (1) the result has been
* returned or (2) it has expired without being harvested. This implies
* a timer that runs while there are pending operations in order to expire
* the unharvested results.
*/ */
static struct btnet_scanstate_s g_scanstate; static struct btnet_scanstate_s g_scanstate;