X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/071e02c6b6b4837fa9cf0b6d4c749994e02638d7..55d7e1e65bccd6b4c44802cf971f39eb05e6e57a:/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h index ff1dec749..131c4aaf2 100644 --- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h +++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h @@ -28,6 +28,11 @@ this software. */ +/** \file + * + * Header file for BluetoothStack.c. + */ + #ifndef _BLUETOOTH_STACK_ #define _BLUETOOTH_STACK_ @@ -58,29 +63,32 @@ #define MAXIMUM_CHANNEL_MTU 255 /* Enums: */ - /** Enum for the possible states for a bluetooth ACL channel. */ + /** Enum for the possible states for a Bluetooth ACL channel. */ enum BT_ChannelStates_t { - Channel_Closed = 0, /**< Channel is closed and inactive. No data may be sent or received. */ - Channel_WaitConnect = 1, /**< A connection request has been received, but a response has not been sent. */ - Channel_WaitConnectRsp = 2, /**< A connection request has been sent, but a response has not been received. */ - Channel_Config_WaitConfig = 3, /**< Channel has been connected, but not yet configured on either end. */ - Channel_Config_WaitSendConfig = 4, /**< Channel configuration has been received and accepted, but not yet sent. */ - Channel_Config_WaitReqResp = 5, /**< Channel configuration has been sent but not responded to, and a configuration - request from the remote end has not yet been received. */ - Channel_Config_WaitResp = 6, /**< Channel configuration has been sent but not accepted, but a configuration request - from the remote end has been accepted. */ - Channel_Config_WaitReq = 7, /**< Channel configuration has been sent and accepted, but a configuration request - from the remote end has not yet been accepted. */ - Channel_Open = 8, /**< Channel is open and ready to send or receive data */ - Channel_WaitDisconnect = 9, /**< A disconnection request has been sent, but not yet acknowledged. */ + BT_Channel_Closed = 0, /**< Channel is closed and inactive. No data may be sent or received. */ + BT_Channel_WaitConnect = 1, /**< A connection request has been received, but a response has not been sent. */ + BT_Channel_WaitConnectRsp = 2, /**< A connection request has been sent, but a response has not been received. */ + BT_Channel_Config_WaitConfig = 3, /**< Channel has been connected, but not yet configured on either end. */ + BT_Channel_Config_WaitSendConfig = 4, /**< Channel configuration has been received and accepted, but not yet sent. */ + BT_Channel_Config_WaitReqResp = 5, /**< Channel configuration has been sent but not responded to, and a configuration + * request from the remote end has not yet been received. + */ + BT_Channel_Config_WaitResp = 6, /**< Channel configuration has been sent but not accepted, but a configuration request + * from the remote end has been accepted. + */ + BT_Channel_Config_WaitReq = 7, /**< Channel configuration has been sent and accepted, but a configuration request + * from the remote end has not yet been accepted. + */ + BT_Channel_Open = 8, /**< Channel is open and ready to send or receive data */ + BT_Channel_WaitDisconnect = 9, /**< A disconnection request has been sent, but not yet acknowledged. */ }; /** Enum for the possible error codes returned by the \ref Bluetooth_SendPacket() function. */ enum BT_SendPacket_ErrorCodes_t { BT_SENDPACKET_NoError = 0, /**< The packet was sent sucessfully. */ - BT_SENDPACKET_NotConnected = 1, /**< The bluetooth stack is not currently connected to a remote device. */ + BT_SENDPACKET_NotConnected = 1, /**< The Bluetooth stack is not currently connected to a remote device. */ BT_SENDPACKET_ChannelNotOpen = 2, /**< The given channel is not currently in the Open state. */ }; @@ -90,12 +98,12 @@ */ typedef struct { - uint8_t State; - uint16_t LocalNumber; - uint16_t RemoteNumber; - uint16_t PSM; - uint16_t LocalMTU; - uint16_t RemoteMTU; + uint8_t State; /**< Current channel state, a value from the \ref BT_ChannelStates_t enum. */ + uint16_t LocalNumber; /**< Local channel number on the device. */ + uint16_t RemoteNumber; /**< Remote channel number on the connected device. */ + uint16_t PSM; /**< Protocol used on the channel. */ + uint16_t LocalMTU; /**< MTU of data sent from the connected device to the local device. */ + uint16_t RemoteMTU; /**< MTU of data sent from the local device to the connected device. */ } Bluetooth_Channel_t; /** Type define for a Bluetooth device connection information structure. This structure contains all the @@ -117,7 +125,7 @@ { uint32_t Class; /**< Class of the local device, a mask of DEVICE_CLASS_* masks. */ char PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */ - char Name[]; /**< Name of the local bluetooth device, up to 248 characters. */ + char Name[]; /**< Name of the local Bluetooth device, up to 248 characters. */ } Bluetooth_Device_t; /** Bluetooth stack state information structure, for the containment of the Bluetooth stack state. The values in @@ -131,7 +139,7 @@ bool IsInitialized; /**< Indicates if the Bluetooth stack is currently initialized and ready for connections * to or from a remote Bluetooth device. */ - uint8_t LocalBDADDR[6]; /**< Local bluetooth adapter's BDADDR, valid when the stack is fully initialized. */ + uint8_t LocalBDADDR[6]; /**< Local Bluetooth adapter's BDADDR, valid when the stack is fully initialized. */ } Bluetooth_Stack_State_t; /* Includes: */