ServiceDiscoveryProtocol.h 9.3 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 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 /* 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. */ #ifndef _SERVICEDISCOVERYPROTOCOL_H_ #define _SERVICEDISCOVERYPROTOCOL_H_ /* Includes: */ #include #include #include #include #include #include #include "BluetoothStack.h" /* Macros: */ #define BT_SDP_DEBUG(l, s, ...) do { if (SDP_DEBUG_LEVEL >= l) printf_P(PSTR("(SDP) " s "\r\n"), ##__VA_ARGS__); } while (0) #define SDP_DEBUG_LEVEL 2 #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  56 57 58 59 60  #define SDP_ATTRIBUTE_ID_SERVICERECORDHANDLE 0x0000 #define SDP_ATTRIBUTE_ID_SERVICECLASSIDS 0x0001 #define SDP_ATTRIBUTE_ID_LANGIDOFFSET 0x0006 #define SDP_ATTRIBUTE_ID_AVAILABILITY 0x0008  Dean Camera committed May 23, 2010 61  #define SDP_ATTRIBUTE_ID_VERSION 0x0200  62 63  #define SDP_ATTRIBUTE_ID_NAME (0x0000 + SDP_ATTRIBUTE_LANGOFFSET) #define SDP_ATTRIBUTE_ID_DESCRIPTION (0x0001 + SDP_ATTRIBUTE_LANGOFFSET)  Dean Camera committed May 08, 2010 64   65 66 67 68  /** Attribute ID offset for localised language string attributes. */ #define SDP_ATTRIBUTE_LANGOFFSET 0x0100 /** Size of a full 128 bit UUID, in bytes. */  Dean Camera committed May 18, 2010 69  #define UUID_SIZE_BYTES 16  Dean Camera committed May 20, 2010 70   71  /** First 96 bits common to all standadized Bluetooth services. */  Dean Camera committed May 08, 2010 72 73  #define BASE_96BIT_UUID 0xFB, 0x34, 0x9B, 0x5F, 0x80, 0x00, 0x00, 0x80, 0x00, 0x10, 0x00, 0x00  Dean Camera committed May 20, 2010 74  /** Terminator for a service attribute table of type \ref ServiceAttributeTable_t. */  Dean Camera committed May 18, 2010 75  #define SERVICE_ATTRIBUTE_TABLE_TERMINATOR {.Data = NULL}  76   Dean Camera committed May 20, 2010 77  /* Enums: */  Dean Camera committed May 23, 2010 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95  /** 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 96 97  enum ServiceDiscovery_DataTypes_t {  Dean Camera committed May 23, 2010 98 99 100 101 102 103 104 105 106  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 107 108  };  Dean Camera committed May 08, 2010 109  /* Type Defines: */  Dean Camera committed May 23, 2010 110 111 112  /** 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 113 114  typedef struct {  Dean Camera committed May 23, 2010 115 116 117  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 118 119  } SDP_PDUHeader_t;  Dean Camera committed May 23, 2010 120 121 122  /** Structure for the association of attribute ID values to an attribute value in FLASH. A table of these * structures can then be built up for each supported UUID service within the device. */  Dean Camera committed May 08, 2010 123 124  typedef struct {  Dean Camera committed May 23, 2010 125 126  uint16_t AttributeID; /**< Attribute ID of the table element which the UUID service supports */ const void* Data; /**< Pointer to the attribute data, located in PROGMEM memory space */  Dean Camera committed May 08, 2010 127 128  } ServiceAttributeTable_t;  Dean Camera committed May 23, 2010 129 130 131  /** Structure for the association of service UUID values to attribute tables stored in FLASH. A table of these * structures can then be built up for each supported UUID service within the device. */  Dean Camera committed May 08, 2010 132 133  typedef struct {  Dean Camera committed May 23, 2010 134 135  uint8_t UUID[UUID_SIZE_BYTES]; /**< UUID of a service supported by the device */ const void* AttributeTable; /**< Pointer to the UUID's attribute table, located in PROGMEM memory space */  Dean Camera committed May 08, 2010 136 137  } ServiceTable_t;  Dean Camera committed May 23, 2010 138  /** Structure for a list of Data Elements containing UUIDs, for service attributes requiring UUID lists. */  Dean Camera committed May 08, 2010 139 140  typedef struct {  Dean Camera committed May 23, 2010 141 142  uint8_t Header; /**< Data Element header, should be (SDP_DATATYPE_Sequence | SDP_DATASIZE_Variable16Bit) */ uint16_t UUID[UUID_SIZE_BYTES]; /**< UUID to store in the list Data Element */  143  } ClassUUID_t;  Dean Camera committed May 20, 2010 144 145  /* Inline Functions: */  146 147 148 149 150 151 152 153 154 155 156 157 158  /** Adds a new Data Element container of the given type 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 container. * * 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 * \param[in] Type Type of data the container is to store, a value from the \ref ServiceDiscovery_DataTypes_t enum * * \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed */  Dean Camera committed May 23, 2010 159  static inline uint16_t* SDP_AddDataElementHeader16(void** BufferPos, const uint8_t Type)  Dean Camera committed May 20, 2010 160  {  Dean Camera committed May 23, 2010 161  *((uint8_t*)*BufferPos) = (SDP_DATASIZE_Variable16Bit | Type);  Dean Camera committed May 20, 2010 162   163  uint16_t* SizePos = (uint16_t*)*(BufferPos + 1);  Dean Camera committed May 21, 2010 164  *SizePos = 0;  Dean Camera committed May 20, 2010 165   166 167  *BufferPos += 3; return SizePos;  Dean Camera committed May 20, 2010 168  }  Dean Camera committed May 08, 2010 169 170  /* Function Prototypes: */  171  void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* Channel);  Dean Camera committed May 08, 2010 172 173  #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)  174 175 176 177  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);  Dean Camera committed May 23, 2010 178 179  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);  180  static ServiceAttributeTable_t* SDP_GetAttributeTable(const uint8_t* const UUID);  Dean Camera committed May 23, 2010 181 182  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);  183 184  static uint32_t SDP_GetLocalAttributeContainerSize(const void* const AttributeData); static uint32_t SDP_GetDataElementSize(const void** const AttributeHeader, uint8_t* const ElementHeaderSize);  Dean Camera committed May 08, 2010 185 186 187  #endif #endif