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 /** \file
  32  *
  33  *  Header file for BluetoothStack.c.
  34  */
  35
  36 #ifndef _BLUETOOTH_STACK_
  37 #define _BLUETOOTH_STACK_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41
  42         /* Macros: */
  43                 #define BLUETOOTH_DATA_IN_PIPE         1
  44                 #define BLUETOOTH_DATA_OUT_PIPE        2
  45                 #define BLUETOOTH_EVENTS_PIPE          3
  46
  47                 #define BLUETOOTH_MAX_OPEN_CHANNELS    6
  48
  49                 #define CHANNEL_PSM_SDP                0x0001
  50                 #define CHANNEL_PSM_UDP                0x0002
  51                 #define CHANNEL_PSM_RFCOMM             0x0003
  52                 #define CHANNEL_PSM_TCP                0x0004
  53                 #define CHANNEL_PSM_IP                 0x0009
  54                 #define CHANNEL_PSM_FTP                0x000A
  55                 #define CHANNEL_PSM_HTTP               0x000C
  56                 #define CHANNEL_PSM_UPNP               0x0010
  57                 #define CHANNEL_PSM_HIDP               0x0011
  58
  59                 #define CHANNEL_SEARCH_LOCALNUMBER     0
  60                 #define CHANNEL_SEARCH_REMOTENUMBER    1
  61                 #define CHANNEL_SEARCH_PSM             2
  62
  63                 #define MAXIMUM_CHANNEL_MTU            255
  64
  65         /* Enums: */
  66                 /** Enum for the possible states for a Bluetooth ACL channel. */
  67                 enum BT_ChannelStates_t
  68                 {
  69                         BT_Channel_Closed                = 0, /**< Channel is closed and inactive. No data may be sent or received. */
  70                         BT_Channel_WaitConnect           = 1, /**< A connection request has been received, but a response has not been sent. */
  71                         BT_Channel_WaitConnectRsp        = 2, /**< A connection request has been sent, but a response has not been received. */
  72                         BT_Channel_Config_WaitConfig     = 3, /**< Channel has been connected, but not yet configured on either end. */
  73                         BT_Channel_Config_WaitSendConfig = 4, /**< Channel configuration has been received and accepted, but not yet sent. */
  74                         BT_Channel_Config_WaitReqResp    = 5, /**< Channel configuration has been sent but not responded to, and a configuration
  75                                                                *   request from the remote end has not yet been received.
  76                                                                */
  77                         BT_Channel_Config_WaitResp       = 6, /**< Channel configuration has been sent but not accepted, but a configuration request
  78                                                                *   from the remote end has been accepted.
  79                                                                */
  80                         BT_Channel_Config_WaitReq        = 7, /**< Channel configuration has been sent and accepted, but a configuration request
  81                                                                *   from the remote end has not yet been accepted.
  82                                                                */
  83                         BT_Channel_Open                  = 8, /**< Channel is open and ready to send or receive data */
  84                         BT_Channel_WaitDisconnect        = 9, /**< A disconnection request has been sent, but not yet acknowledged. */
  85                 };
  86
  87                 /** Enum for the possible error codes returned by the \ref Bluetooth_SendPacket() function. */
  88                 enum BT_SendPacket_ErrorCodes_t
  89                 {
  90                         BT_SENDPACKET_NoError            = 0, /**< The packet was sent successfully. */
  91                         BT_SENDPACKET_NotConnected       = 1, /**< The Bluetooth stack is not currently connected to a remote device. */
  92                         BT_SENDPACKET_ChannelNotOpen     = 2, /**< The given channel is not currently in the Open state. */
  93                 };
  94
  95         /* Type Defines: */
  96                 /** Type define for a Bluetooth ACL channel information structure. This structure contains all the relevant
  97                  *  information on an ACL channel for data transmission and reception by the stack.
  98                  */
  99                 typedef struct
 100                 {
 101                         uint8_t  State; /**< Current channel state, a value from the \ref BT_ChannelStates_t enum. */
 102                         uint16_t LocalNumber; /**< Local channel number on the device. */
 103                         uint16_t RemoteNumber; /**< Remote channel number on the connected device. */
 104                         uint16_t PSM; /**< Protocol used on the channel. */
 105                         uint16_t LocalMTU; /**< MTU of data sent from the connected device to the local device. */
 106                         uint16_t RemoteMTU; /**< MTU of data sent from the local device to the connected device. */
 107                 } Bluetooth_Channel_t;
 108
 109                 /** Type define for a Bluetooth device connection information structure. This structure contains all the
 110                  *  information needed to maintain a connection to a remote Bluetooth device via the Bluetooth stack.
 111                  */
 112                 typedef struct
 113                 {
 114                         bool                IsConnected; /**< Indicates if the stack is currently connected to a remote device - if this value is
 115                                                           *   false, the remaining elements are invalid.
 116                                                                                           */
 117                         uint16_t            ConnectionHandle; /**< Connection handle to the remote device, used internally in the stack. */
 118                         uint8_t             RemoteAddress[6]; /**< Bluetooth device address of the attached remote device. */
 119                         Bluetooth_Channel_t Channels[BLUETOOTH_MAX_OPEN_CHANNELS]; /**< Channel information structures for the connection. */
 120                         uint8_t             SignalingIdentifier; /**< Next Signaling Channel unique command sequence identifier. */
 121                 } Bluetooth_Connection_t;
 122
 123                 /** Local Bluetooth device information structure, for the defining of local device characteristics for the Bluetooth stack. */
 124                 typedef struct
 125                 {
 126                         uint32_t Class; /**< Class of the local device, a mask of DEVICE_CLASS_* masks. */
 127                         char     PINCode[16]; /**< Pin code required to send or receive in order to authenticate with a remote device. */
 128                         char     Name[]; /**< Name of the local Bluetooth device, up to 248 characters. */
 129                 } Bluetooth_Device_t;
 130
 131                 /** Bluetooth stack state information structure, for the containment of the Bluetooth stack state. The values in
 132                  *  this structure are set by the Bluetooth stack internally, and should all be treated as read only by the user
 133                  *  application.
 134                  */
 135                 typedef struct
 136                 {
 137                         uint8_t CurrentHCIState; /**< Current HCI state machine state. */
 138                         uint8_t NextHCIState; /**< Next HCI state machine state to progress to once the currently issued command completes. */
 139                         bool    IsInitialized; /**< Indicates if the Bluetooth stack is currently initialized and ready for connections
 140                                                 *   to or from a remote Bluetooth device.
 141                                                 */
 142                         uint8_t LocalBDADDR[6]; /**< Local Bluetooth adapter's BDADDR, valid when the stack is fully initialized. */
 143                 } Bluetooth_Stack_State_t;
 144
 145         /* Includes: */
 146                 #include "BluetoothHCICommands.h"
 147                 #include "BluetoothACLPackets.h"
 148
 149         /* Function Prototypes: */
 150                 void Bluetooth_Stack_Init(void);
 151                 void Bluetooth_Stack_USBTask(void);
 152
 153                 void                 Bluetooth_StackInitialized(void);
 154                 bool                 Bluetooth_ConnectionRequest(const uint8_t* RemoteAddress);
 155                 void                 Bluetooth_ConnectionComplete(void);
 156                 void                 Bluetooth_DisconnectionComplete(void);
 157                 bool                 Bluetooth_ChannelConnectionRequest(const uint16_t PSM);
 158                 void                 Bluetooth_PacketReceived(void* Data, uint16_t DataLen,
 159                                                               Bluetooth_Channel_t* const ACLChannel);
 160                 void                 Bluetooth_ChannelOpened(Bluetooth_Channel_t* const ACLChannel);
 161
 162                 Bluetooth_Channel_t* Bluetooth_GetChannelData(const uint16_t SearchValue,
 163                                                               const uint8_t SearchKey);
 164                 Bluetooth_Channel_t* Bluetooth_OpenChannel(const uint16_t PSM);
 165                 void                 Bluetooth_CloseChannel(Bluetooth_Channel_t* const ACLChannel);
 166                 uint8_t              Bluetooth_SendPacket(void* Data,
 167                                                           uint16_t DataLen,
 168                                                           Bluetooth_Channel_t* const ACLChannel);
 169
 170         /* External Variables: */
 171                 extern Bluetooth_Device_t      Bluetooth_DeviceConfiguration;
 172                 extern Bluetooth_Connection_t  Bluetooth_Connection;
 173                 extern Bluetooth_Stack_State_t Bluetooth_State;
 174
 175 #endif