SDP Service improvements; fixed UUID for SDP service, added Service Discovery Server...
[pub/USBasp.git] / Demos / Host / Incomplete / BluetoothHost / Lib / ServiceDiscoveryProtocol.h
index c65a341..bf79c53 100644 (file)
@@ -58,6 +58,7 @@
                #define SDP_ATTRIBUTE_ID_SERVICECLASSIDS        0x0001
                #define SDP_ATTRIBUTE_ID_LANGIDOFFSET           0x0006
                #define SDP_ATTRIBUTE_ID_AVAILABILITY           0x0008
+               #define SDP_ATTRIBUTE_ID_VERSION                0x0200
                #define SDP_ATTRIBUTE_ID_NAME                  (0x0000 + SDP_ATTRIBUTE_LANGOFFSET)
                #define SDP_ATTRIBUTE_ID_DESCRIPTION           (0x0001 + SDP_ATTRIBUTE_LANGOFFSET)
                
                #define SERVICE_ATTRIBUTE_TABLE_TERMINATOR      {.Data = NULL}
                
        /* Enums: */
+               /** 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.
+                */
                enum ServiceDiscovery_DataTypes_t
                {
-                       SDP_DATATYPE_Nill        = (0 << 3),
-                       SDP_DATATYPE_UnsignedInt = (1 << 3),
-                       SDP_DATATYPE_SignedInt   = (2 << 3),
-                       SDP_DATATYPE_UUID        = (3 << 3),
-                       SDP_DATATYPE_String      = (4 << 3),
-                       SDP_DATATYPE_Boolean     = (5 << 3),
-                       SDP_DATATYPE_Sequence    = (6 << 3),
-                       SDP_DATATYPE_Alternative = (7 << 3),
-                       SDP_DATATYPE_URL         = (8 << 3),
+                       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. */
                };
 
        /* Type Defines: */
+               /** Header for all SPD transaction packets. This header is sent at the start of all SDP packets sent to or from a SDP
+                *  server.
+                */
                typedef struct
                {
-                       uint8_t  PDU;
-                       uint16_t TransactionID;
-                       uint16_t ParameterLength;
+                       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 */
                } SDP_PDUHeader_t;
                
+               /** 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.
+                */
                typedef struct
                {
-                       uint16_t    AttributeID;
-                       const void* Data;
+                       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 */
                } ServiceAttributeTable_t;
 
+               /** 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.
+                */
                typedef struct
                {
-                       uint8_t UUID[16];
-                       const void* AttributeTable;
+                       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 */
                } ServiceTable_t;
 
+               /** Structure for a list of Data Elements containing UUIDs, for service attributes requiring UUID lists. */
                typedef struct
                {
-                       uint8_t  Header;
-                       uint8_t  Size;
-                       uint16_t UUID[UUID_SIZE_BYTES];
+                       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 */
                } ClassUUID_t;
 
        /* Inline Functions: */
                 *
                 *  \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed
                 */
-               static inline uint16_t* SDP_AddDataElementHeader16(uint8_t** BufferPos, const uint8_t Type)
+               static inline uint16_t* SDP_AddDataElementHeader16(void** BufferPos, const uint8_t Type)
                {
-                       **BufferPos = (6 | Type);       
+                       *((uint8_t*)*BufferPos) = (SDP_DATASIZE_Variable16Bit | Type);  
 
                        uint16_t* SizePos = (uint16_t*)*(BufferPos + 1);
                        *SizePos = 0;
                        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);
 
-                       static void* SDP_GetAttributeValue(const ServiceAttributeTable_t* AttributeTable, const uint16_t AttributeID);
+                       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);
                        static ServiceAttributeTable_t* SDP_GetAttributeTable(const uint8_t* const UUID);
-                       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);
+                       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);
                        static uint32_t SDP_GetLocalAttributeContainerSize(const void* const AttributeData);
                        static uint32_t SDP_GetDataElementSize(const void** const AttributeHeader, uint8_t* const ElementHeaderSize);
                #endif