Document inline SDP data read/write functions.
[pub/lufa.git] / Demos / Host / Incomplete / BluetoothHost / Lib / ServiceDiscoveryProtocol.h
index a9ed417..c9ce951 100644 (file)
   this software.
 */
 
+/** \file
+ *
+ *  Header file for ServiceDiscoveryProtocol.c.
+ */
+
 #ifndef _SERVICEDISCOVERYPROTOCOL_H_
 #define _SERVICEDISCOVERYPROTOCOL_H_
 
@@ -41,6 +46,7 @@
                #include <LUFA/Drivers/Peripheral/SerialStream.h>
 
                #include "BluetoothStack.h"
+               #include "SDPServices.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_PDU_SERVICESEARCHATTRIBUTEREQUEST   0x06
                #define SDP_PDU_SERVICESEARCHATTRIBUTERESPONSE  0x07
 
-               #define SDP_ATTRIBUTE_ID_SERVICERECORDHANDLE    0x0000
-               #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)
-               
-               /** Attribute ID offset for localised language string attributes. */
-               #define SDP_ATTRIBUTE_LANGOFFSET                0x0100
-
-               /** Size of a full 128 bit UUID, in bytes. */
-               #define UUID_SIZE_BYTES                         16
-               
-               /** First 96 bits common to all standadized Bluetooth services. */
-               #define BASE_96BIT_UUID                         0xFB, 0x34, 0x9B, 0x5F, 0x80, 0x00, 0x00, 0x80, 0x00, 0x10, 0x00, 0x00
-               
-               /** Terminator for a service attribute table of type \ref ServiceAttributeTable_t. */
-               #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.
                        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.
+       /* Inline Functions: */
+               /** Writes 8 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
                 */
-               typedef struct
+               static inline void SDP_WriteData8(void** BufferPos, uint8_t 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;
+                       *((uint8_t*)*BufferPos) = Data;
+                       *BufferPos += sizeof(uint8_t);
+               }
+               
+               /** 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
+                */
+               static inline void SDP_WriteData16(void** BufferPos, uint16_t Data)
+               {
+                       *((uint16_t*)*BufferPos) = SwapEndian_16(Data);
+                       *BufferPos += sizeof(uint16_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.
+               /** 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
                 */
-               typedef struct
+               static inline void SDP_WriteData32(void** BufferPos, uint32_t Data)
                {
-                       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;
+                       *((uint32_t*)*BufferPos) = SwapEndian_32(Data);
+                       *BufferPos += sizeof(uint32_t);
+               }
 
-               /** Structure for a list of Data Elements containing UUIDs, for service attributes requiring UUID lists. */
-               typedef struct
+               /** 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
+                */
+               static inline uint8_t SDP_ReadData8(const void** BufferPos)
                {
-                       uint8_t Header; /**< Data Element header, should be (SDP_DATATYPE_UUID | SDP_DATASIZE_128Bit) */
-                       uint8_t UUID[UUID_SIZE_BYTES]; /**< UUID to store in the list Data Element */
-               } ClassUUID_t;
+                       uint8_t Data = *((uint8_t*)*BufferPos);
+                       *BufferPos += sizeof(uint8_t);
+                       
+                       return Data;
+               }
 
-               /** Structure for a list of Data Elements containing Version Numbers, for service attributes requiring Version lists. */
-               typedef struct
+               /** 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
+                */
+               static inline uint16_t SDP_ReadData16(const void** BufferPos)
                {
-                       uint8_t  Header; /**< Data Element header, should be (SDP_DATATYPE_UnsignedInt | SDP_DATASIZE_16Bit) */
-                       uint16_t Version; /**< Version number to store in the list Data Element */
-               } Version_t;
-               
-       /* Inline Functions: */
+                       uint16_t Data = SwapEndian_16(*((uint16_t*)*BufferPos));
+                       *BufferPos += sizeof(uint16_t);
+                       
+                       return Data;
+               }
+
+               /** 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
+                */
+               static inline uint32_t SDP_ReadData32(const void** BufferPos)
+               {
+                       uint32_t Data = SwapEndian_32(*((uint32_t*)*BufferPos));
+                       *BufferPos += sizeof(uint32_t);
+                       
+                       return Data;
+               }
+
                /** 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
                 */
                static inline uint16_t* SDP_AddDataElementHeader16(void** BufferPos, const uint8_t Type)
                {
-                       *((uint8_t*)*BufferPos) = (SDP_DATASIZE_Variable16Bit | Type);  
+                       SDP_WriteData8(BufferPos, (SDP_DATASIZE_Variable16Bit | Type));
 
-                       uint16_t* SizePos = (uint16_t*)*(BufferPos + 1);
-                       *SizePos = 0;
+                       uint16_t* SizePos = (uint16_t*)*BufferPos;
+                       
+                       SDP_WriteData16(BufferPos, 0);
 
-                       *BufferPos += 3;                        
                        return SizePos;
                }
                
        /* Function Prototypes: */
-               void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* Channel);
+               void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);
 
                #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
                        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);
 
+                       static uint16_t SDP_AddListedAttributesToResponse(const ServiceAttributeTable_t* AttributeTable, uint16_t AttributeList[][2],
+                                                                         const uint8_t TotalAttributes, void** const BufferPos);
                        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);