ServiceDiscoveryProtocol.h 10.4 KB
 Dean Camera committed May 08, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) 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 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. */  31 32 33 34 35 /** \file * * Header file for ServiceDiscoveryProtocol.c. */  Dean Camera committed May 08, 2010 36 37 38 39 40 41 42 43 44 45 46 47 48 #ifndef _SERVICEDISCOVERYPROTOCOL_H_ #define _SERVICEDISCOVERYPROTOCOL_H_ /* Includes: */ #include #include #include #include #include #include #include "BluetoothStack.h"  49  #include "SDPServices.h"  Dean Camera committed May 08, 2010 50 51 52  /* Macros: */ #define BT_SDP_DEBUG(l, s, ...) do { if (SDP_DEBUG_LEVEL >= l) printf_P(PSTR("(SDP) " s "\r\n"), ##__VA_ARGS__); } while (0)  Dean Camera committed Jun 02, 2010 53  #define SDP_DEBUG_LEVEL 0  Dean Camera committed May 08, 2010 54 55 56 57 58 59 60 61  #define SDP_PDU_ERRORRESPONSE 0x01 #define SDP_PDU_SERVICESEARCHREQUEST 0x02 #define SDP_PDU_SERVICESEARCHRESPONSE 0x03 #define SDP_PDU_SERVICEATTRIBUTEREQUEST 0x04 #define SDP_PDU_SERVICEATTRIBUTERESPONSE 0x05 #define SDP_PDU_SERVICESEARCHATTRIBUTEREQUEST 0x06 #define SDP_PDU_SERVICESEARCHATTRIBUTERESPONSE 0x07  Dean Camera committed Jun 02, 2010 62   Dean Camera committed Jun 03, 2010 63 64 65 66 67 68  /** Convenience macro - read a pointer out of PROGMEM space. * * \param[in] x Address of the pointer to read * * \return Pointer retrieved from PROGMEM space */  Dean Camera committed Jun 02, 2010 69  #define pgm_read_ptr(x) (void*)pgm_read_word(x)  70   Dean Camera committed May 20, 2010 71  /* Enums: */  Dean Camera committed May 23, 2010 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89  /** Data sizes for SDP Data Element headers, to indicate the size of the data contained in the element. When creating * a Data Element, a value from this enum should be ORed with a value from the \ref ServiceDiscovery_DataTypes_t enum. */ enum ServiceDiscovery_DataSizes_t { SDP_DATASIZE_8Bit = 0, /**< Contained data is 8 bits in length. */ SDP_DATASIZE_16Bit = 1, /**< Contained data is 16 bits in length. */ SDP_DATASIZE_32Bit = 2, /**< Contained data is 32 bits in length. */ SDP_DATASIZE_64Bit = 3, /**< Contained data is 64 bits in length. */ SDP_DATASIZE_128Bit = 4, /**< Contained data is 128 bits in length. */ SDP_DATASIZE_Variable8Bit = 5, /**< Contained data is encoded in an 8 bit size integer following the header. */ SDP_DATASIZE_Variable16Bit = 6, /**< Contained data is encoded in an 16 bit size integer following the header. */ SDP_DATASIZE_Variable32Bit = 7, /**< Contained data is encoded in an 32 bit size integer following the header. */ }; /** Data types for SDP Data Element headers, to indicate the type of data contained in the element. When creating * a Data Element, a value from this enum should be ORed with a value from the \ref ServiceDiscovery_DataSizes_t enum. */  Dean Camera committed May 20, 2010 90 91  enum ServiceDiscovery_DataTypes_t {  Dean Camera committed May 23, 2010 92 93 94 95 96 97 98 99 100  SDP_DATATYPE_Nill = (0 << 3), /**< Indicates the container data is a Nill (null) type. */ SDP_DATATYPE_UnsignedInt = (1 << 3), /**< Indicates the container data is an unsigned integer. */ SDP_DATATYPE_SignedInt = (2 << 3), /**< Indicates the container data is a signed integer. */ SDP_DATATYPE_UUID = (3 << 3), /**< Indicates the container data is a UUID. */ SDP_DATATYPE_String = (4 << 3), /**< Indicates the container data is an ASCII string. */ SDP_DATATYPE_Boolean = (5 << 3), /**< Indicates the container data is a logical boolean. */ SDP_DATATYPE_Sequence = (6 << 3), /**< Indicates the container data is a sequence of containers. */ SDP_DATATYPE_Alternative = (7 << 3), /**< Indicates the container data is a sequence of alternative containers. */ SDP_DATATYPE_URL = (8 << 3), /**< Indicates the container data is a URL. */  Dean Camera committed May 20, 2010 101 102  };  Dean Camera committed May 08, 2010 103  /* Type Defines: */  Dean Camera committed May 23, 2010 104 105 106  /** Header for all SPD transaction packets. This header is sent at the start of all SDP packets sent to or from a SDP * server. */  Dean Camera committed May 08, 2010 107 108  typedef struct {  Dean Camera committed May 23, 2010 109 110 111  uint8_t PDU; /**< SDP packet type, a SDP_PDU_* mask value */ uint16_t TransactionID; /**< Unique transaction ID number to associate requests and responses */ uint16_t ParameterLength; /**< Length of the data following the SDP header */  Dean Camera committed May 08, 2010 112 113  } SDP_PDUHeader_t;  Dean Camera committed May 20, 2010 114  /* Inline Functions: */  Dean Camera committed Jun 01, 2010 115  /** Writes 8 bits of raw data to the given buffer, incrementing the buffer position afterwards.  116  *  Dean Camera committed Jun 01, 2010 117 118  * \param[in, out] BufferPos Current position in the buffer where the data is to be written to * \param[in] Data Data to write to the buffer  119  */  120 121 122 123 124 125  static inline void SDP_WriteData8(void** BufferPos, uint8_t Data) { *((uint8_t*)*BufferPos) = Data; *BufferPos += sizeof(uint8_t); }  Dean Camera committed Jun 01, 2010 126 127 128 129 130  /** Writes 16 bits of raw data to the given buffer, incrementing the buffer position afterwards. * * \param[in, out] BufferPos Current position in the buffer where the data is to be written to * \param[in] Data Data to write to the buffer */  131 132 133 134 135 136  static inline void SDP_WriteData16(void** BufferPos, uint16_t Data) { *((uint16_t*)*BufferPos) = SwapEndian_16(Data); *BufferPos += sizeof(uint16_t); }  Dean Camera committed Jun 01, 2010 137 138 139 140 141  /** Writes 32 bits of raw data to the given buffer, incrementing the buffer position afterwards. * * \param[in, out] BufferPos Current position in the buffer where the data is to be written to * \param[in] Data Data to write to the buffer */  142 143 144 145 146 147  static inline void SDP_WriteData32(void** BufferPos, uint32_t Data) { *((uint32_t*)*BufferPos) = SwapEndian_32(Data); *BufferPos += sizeof(uint32_t); }  Dean Camera committed Jun 01, 2010 148 149 150 151 152 153  /** Reads 8 bits of raw data frpm the given buffer, incrementing the buffer position afterwards. * * \param[in, out] BufferPos Current position in the buffer where the data is to be read from * * \return Data read from the buffer */  154 155 156 157 158 159 160 161  static inline uint8_t SDP_ReadData8(const void** BufferPos) { uint8_t Data = *((uint8_t*)*BufferPos); *BufferPos += sizeof(uint8_t); return Data; }  Dean Camera committed Jun 01, 2010 162 163 164 165 166 167  /** Reads 16 bits of raw data frpm the given buffer, incrementing the buffer position afterwards. * * \param[in, out] BufferPos Current position in the buffer where the data is to be read from * * \return Data read from the buffer */  168 169 170 171 172 173 174 175  static inline uint16_t SDP_ReadData16(const void** BufferPos) { uint16_t Data = SwapEndian_16(*((uint16_t*)*BufferPos)); *BufferPos += sizeof(uint16_t); return Data; }  Dean Camera committed Jun 01, 2010 176 177 178 179 180 181  /** Reads 32 bits of raw data frpm the given buffer, incrementing the buffer position afterwards. * * \param[in, out] BufferPos Current position in the buffer where the data is to be read from * * \return Data read from the buffer */  182 183 184 185 186 187 188  static inline uint32_t SDP_ReadData32(const void** BufferPos) { uint32_t Data = SwapEndian_32(*((uint32_t*)*BufferPos)); *BufferPos += sizeof(uint32_t); return Data; }  Dean Camera committed Jun 01, 2010 189   Dean Camera committed Jun 01, 2010 190 191 192 193  /** Adds a new Data Element Sequence container with a 16-bit size header to the buffer. The buffer * pointer's position is advanced past the added header once the element has been added. The returned * size header value is pre-zeroed out so that it can be incremented as data is placed into the Data * Element Sequence container.  Dean Camera committed Jun 01, 2010 194 195 196 197 198 199 200 201  * * The total added size of the container header is three bytes, regardless of the size of its contents * as long as the contents' size in bytes fits into a 16-bit integer. * * \param[in, out] BufferPos Pointer to a buffer where the container header is to be placed * * \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed */  Dean Camera committed Jun 01, 2010 202  static inline uint16_t* SDP_AddSequence16(void** BufferPos)  Dean Camera committed Jun 01, 2010 203  {  Dean Camera committed Jun 01, 2010 204  SDP_WriteData8(BufferPos, (SDP_DATASIZE_Variable16Bit | SDP_DATATYPE_Sequence));  Dean Camera committed Jun 01, 2010 205   Dean Camera committed Jun 01, 2010 206  uint16_t* SizePos = *BufferPos;  Dean Camera committed Jun 01, 2010 207 208 209 210  SDP_WriteData16(BufferPos, 0); return SizePos; }  211   Dean Camera committed May 08, 2010 212  /* Function Prototypes: */  Dean Camera committed Jun 01, 2010 213  void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);  Dean Camera committed May 08, 2010 214 215  #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)  Dean Camera committed Jun 03, 2010 216 217 218  static void SDP_ProcessServiceSearch(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel); static void SDP_ProcessServiceAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel); static void SDP_ProcessServiceSearchAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);  219   Dean Camera committed Jun 01, 2010 220 221  static uint16_t SDP_AddListedAttributesToResponse(const ServiceAttributeTable_t* AttributeTable, uint16_t AttributeList[][2], const uint8_t TotalAttributes, void** const BufferPos);  Dean Camera committed May 23, 2010 222 223  static uint16_t SDP_AddAttributeToResponse(const uint16_t AttributeID, const void* AttributeValue, void** ResponseBuffer); static void* SDP_GetAttributeValue(const ServiceAttributeTable_t* AttributeTable, const uint16_t AttributeID);  Dean Camera committed Jun 02, 2010 224 225 226 227 228 229  static bool SDP_SearchServiceTable(uint8_t UUIDList[][UUID_SIZE_BYTES], const uint8_t TotalUUIDs, const ServiceAttributeTable_t* CurrAttributeTable); static void SDP_CheckUUIDMatch(uint8_t UUIDList[][UUID_SIZE_BYTES], const uint8_t TotalUUIDs, bool UUIDMatch[], const void* CurrAttribute);  Dean Camera committed May 23, 2010 230 231  static uint8_t SDP_GetAttributeList(uint16_t AttributeList[][2], const void** const CurrentParameter); static uint8_t SDP_GetUUIDList(uint8_t UUIDList[][UUID_SIZE_BYTES], const void** const CurrentParameter);  Dean Camera committed Jun 02, 2010 232   Dean Camera committed May 23, 2010 233  static uint32_t SDP_GetLocalAttributeContainerSize(const void* const AttributeData, uint8_t* const HeaderSize);  234  static uint32_t SDP_GetDataElementSize(const void** const AttributeHeader, uint8_t* const ElementHeaderSize);  Dean Camera committed May 08, 2010 235 236 237  #endif #endif