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