Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothStack.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 #ifndef _BLUETOOTH_STACK_
  32 #define _BLUETOOTH_STACK_
  33
  34         /* Includes: */
  35                 #include <LUFA/Drivers/USB/USB.h>
  36
  37         /* Macros: */
  38                 #define BLUETOOTH_DATA_IN_PIPE         1
  39                 #define BLUETOOTH_DATA_OUT_PIPE        2
  40                 #define BLUETOOTH_EVENTS_PIPE          3
  41
  42                 #define BLUETOOTH_MAX_OPEN_CHANNELS    6
  43
  44                 #define CHANNEL_PSM_SDP                0x0001
  45                 #define CHANNEL_PSM_UDP                0x0002
  46                 #define CHANNEL_PSM_RFCOMM             0x0003
  47                 #define CHANNEL_PSM_TCP                0x0004
  48                 #define CHANNEL_PSM_IP                 0x0009
  49                 #define CHANNEL_PSM_FTP                0x000A
  50                 #define CHANNEL_PSM_HTTP               0x000C
  51                 #define CHANNEL_PSM_UPNP               0x0010
  52                 #define CHANNEL_PSM_HIDP               0x0011
  53
  54                 #define CHANNEL_SEARCH_LOCALNUMBER     0
  55                 #define CHANNEL_SEARCH_REMOTENUMBER    1
  56                 #define CHANNEL_SEARCH_PSM             2
  57
  58                 #define MAXIMUM_CHANNEL_MTU            255
  59
  60         /* Enums: */
  61                 /** Enum for the possible states for a bluetooth ACL channel. */
  62                 enum BT_ChannelStates_t
  63                 {
  64                         Channel_Closed                = 0, /**< Channel is closed and inactive. No data may be sent or received. */
  65                         Channel_WaitConnect           = 1, /**< A connection request has been received, but a response has not been sent. */
  66                         Channel_WaitConnectRsp        = 2, /**< A connection request has been sent, but a response has not been received. */
  67                         Channel_Config_WaitConfig     = 3, /**< Channel has been connected, but not yet configured on either end. */
  68                         Channel_Config_WaitSendConfig = 4, /**< Channel configuration has been received and accepted, but not yet sent. */
  69                         Channel_Config_WaitReqResp    = 5, /**< Channel configuration has been sent but not responded to, and a configuration
  70                                                                 request from the remote end has not yet been received. */
  71                         Channel_Config_WaitResp       = 6, /**< Channel configuration has been sent but not accepted, but a configuration request
  72                                                                 from the remote end has been accepted. */
  73                         Channel_Config_WaitReq        = 7, /**< Channel configuration has been sent and accepted, but a configuration request
  74                                                                 from the remote end has not yet been accepted. */
  75                         Channel_Open                  = 8, /**< Channel is open and ready to send or receive data */
  76                         Channel_WaitDisconnect        = 9, /**< A disconnection request has been sent, but not yet acknowledged. */
  77                 };
  78
  79                 /** Enum for the possible error codes returned by the \ref Bluetooth_SendPacket() function. */
  80                 enum BT_SendPacket_ErrorCodes_t
  81                 {
  82                         BT_SENDPACKET_NoError            = 0, /**< The packet was sent sucessfully. */
  83                         BT_SENDPACKET_NotConnected       = 1, /**< The bluetooth stack is not currently connected to a remote device. */
  84                         BT_SENDPACKET_ChannelNotOpen     = 2, /**< The given channel is not currently in the Open state. */
  85                 };
  86
  87         /* Type Defines: */
  88                 /** Type define for a Bluetooth ACL channel information structure. This structure contains all the relevent
  89                  *  information on an ACL channel for data transmission and reception by the stack.
  90                  */
  91                 typedef struct
  92                 {
  93                         uint8_t  State;
  94                         uint16_t LocalNumber;
  95                         uint16_t RemoteNumber;
  96                         uint16_t PSM;
  97                         uint16_t LocalMTU;
  98                         uint16_t RemoteMTU;
  99                 } Bluetooth_Channel_t;
 100
 101                 /** Type define for a Bluetooth device connection information structure. This structure contains all the
 102                  *  information needed to maintain a connection to a remote Bluetooth device via the Bluetooth stack.
 103                  */
 104                 typedef struct
 105                 {
 106                         bool                IsConnected; /**< Indicates if the stack is currently connected to a remote device - if this value is
 107                                                           *   false, the remaining elements are invalid.
 108                                                                                           */
 109                         uint16_t            ConnectionHandle; /**< Connection handle to the remote device, used internally in the stack. */
 110                         uint8_t             RemoteAddress[6]; /**< Bluetooth device address of the attached remote device. */
 111                         Bluetooth_Channel_t Channels[BLUETOOTH_MAX_OPEN_CHANNELS]; /**< Channel information structures for the connection. */
 112                         uint8_t             SignallingIdentifier; /**< Next Signalling Channel unique command sequence identifier. */
 113                 } Bluetooth_Connection_t;
 114
 115                 /** Local Bluetooth device information structure, for the defining of local device characteristics for the Bluetooth stack. */
 116                 typedef struct
 117                 {
 118                         uint32_t Class; /**< Class of the local device, a mask of DEVICE_CLASS_* masks. */
 119                         char     PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */
 120                         char     Name[]; /**< Name of the local bluetooth device, up to 248 characters. */
 121                 } Bluetooth_Device_t;
 122
 123                 /** Bluetooth stack state information structure, for the containment of the Bluetooth stack state. The values in
 124                  *  this structure are set by the Bluetooth stack internally, and should all be treated as read only by the user
 125                  *  application.
 126                  */
 127                 typedef struct
 128                 {
 129                         uint8_t CurrentHCIState; /**< Current HCI state machine state. */
 130                         uint8_t NextHCIState; /**< Next HCI state machine state to progress to once the currently issued command completes. */
 131                         bool    IsInitialized; /**< Indicates if the Bluetooth stack is currently initialized and ready for connections
 132                                                 *   to or from a remote Bluetooth device.
 133                                                 */
 134                         uint8_t LocalBDADDR[6]; /**< Local bluetooth adapter's BDADDR, valid when the stack is fully initialized. */
 135                 } Bluetooth_Stack_State_t;
 136
 137         /* Includes: */
 138                 #include "BluetoothHCICommands.h"
 139                 #include "BluetoothACLPackets.h"
 140
 141         /* Function Prototypes: */
 142                 void Bluetooth_Stack_Init(void);
 143                 void Bluetooth_Stack_USBTask(void);
 144
 145                 void                 Bluetooth_StackInitialized(void);
 146                 bool                 Bluetooth_ConnectionRequest(const uint8_t* RemoteAddress);
 147                 void                 Bluetooth_ConnectionComplete(void);
 148                 void                 Bluetooth_DisconnectionComplete(void);
 149                 bool                 Bluetooth_ChannelConnectionRequest(const uint16_t PSM);
 150                 void                 Bluetooth_PacketReceived(void* Data, uint16_t DataLen, Bluetooth_Channel_t* const Channel);
 151                 Bluetooth_Channel_t* Bluetooth_GetChannelData(const uint16_t SearchValue, const uint8_t SearchKey);
 152                 Bluetooth_Channel_t* Bluetooth_OpenChannel(const uint16_t PSM);
 153                 void                 Bluetooth_CloseChannel(Bluetooth_Channel_t* const Channel);
 154                 uint8_t              Bluetooth_SendPacket(void* Data, uint16_t DataLen, Bluetooth_Channel_t* const Channel);
 155
 156         /* External Variables: */
 157                 extern Bluetooth_Device_t      Bluetooth_DeviceConfiguration;
 158                 extern Bluetooth_Connection_t  Bluetooth_Connection;
 159                 extern Bluetooth_Stack_State_t Bluetooth_State;
 160
 161 #endif