Oops - descriptor pointer should be assigned, not incremented with the new type-safe...

[pub/lufa.git] / Demos / Host / Incomplete / BluetoothHost / Lib / ServiceDiscoveryProtocol.h
diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h b/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h

index 7986d5e..e46729c 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h
@@ -28,6 +28,11 @@
    this software.
  */
  
    this software.
  */
  
+/** \file
+ *
+ *  Header file for ServiceDiscoveryProtocol.c.
+ */
+
  #ifndef _SERVICEDISCOVERYPROTOCOL_H_
  #define _SERVICEDISCOVERYPROTOCOL_H_
  
  #ifndef _SERVICEDISCOVERYPROTOCOL_H_
  #define _SERVICEDISCOVERYPROTOCOL_H_
  
@@ -41,10 +46,11 @@
                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  
                 #include "BluetoothStack.h"
                 #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)
                 
         /* 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_DEBUG_LEVEL                         0
                 
                 #define SDP_PDU_ERRORRESPONSE                   0x01
                 #define SDP_PDU_SERVICESEARCHREQUEST            0x02
                 
                 #define SDP_PDU_ERRORRESPONSE                   0x01
                 #define SDP_PDU_SERVICESEARCHREQUEST            0x02
@@ -54,154 +60,172 @@
                 #define SDP_PDU_SERVICESEARCHATTRIBUTEREQUEST   0x06
                 #define SDP_PDU_SERVICESEARCHATTRIBUTERESPONSE  0x07
                 
                 #define SDP_PDU_SERVICESEARCHATTRIBUTEREQUEST   0x06
                 #define SDP_PDU_SERVICESEARCHATTRIBUTERESPONSE  0x07
                 
-               #define SDP_ATTRIBUTE_NAME                      0x0000
-               #define SDP_ATTRIBUTE_DESCRIPTION               0x0001
-               #define SDP_ATTRIBUTE_PROVIDER                  0x0002
-               #define SDP_ATTRIBUTE_AVAILABILITY              0x0008
-               
-               /** 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
-               
-               /** Defines a service attribute as a string of characters.
-                *
-                *  \param name    Name of the attribute (used to identify the attribute variable only)
-                *  \param string  String of characters to associate with the attribute
-                */
-               #define SERVICE_ATTRIBUTE_TEXT(name, string)    SERVICE_ATTRIBUTE_LEN8(name, SDP_DATATYPE_String, sizeof(string), string)
-
-               /** Defines a service attribute with a contents that can fit into an 8-bit integer.
-                *
-                *  \param name    Name of the attribute (used to identify the attribute variable only)
-                *  \param type    Type of attribute contents, a value from the \ref ServiceDiscovery_DataTypes_t enum
-                *  \param size    Size of the data, in bytes
-                *  \param ...     Data to associate with the attribute
-                */
-               #define SERVICE_ATTRIBUTE_LEN8(name, type, size, ...)  const ServiceAttributeData8Bit_t  name PROGMEM = \
-                                                               {.Header = (type | 5), .Size = size, .Data = __VA_ARGS__}
+               #define pgm_read_ptr(x)                         (void*)pgm_read_word(x)
  
  
-               /** Defines a service attribute with a contents that can fit into an 16-bit integer.
-                *
-                *  \param name    Name of the attribute (used to identify the attribute variable only)
-                *  \param type    Type of attribute contents, a value from the \ref ServiceDiscovery_DataTypes_t enum
-                *  \param size    Size of the data, in bytes
-                *  \param ...     Data to associate with the attribute
+       /* 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.
                  */
                  */
-               #define SERVICE_ATTRIBUTE_LEN16(name, type, size, ...) const ServiceAttributeData16Bit_t name PROGMEM = \
-                                                               {.Header = (type | 6), .Size = size, .Data = __VA_ARGS__}
+               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. */
+               };
  
  
-               /** Defines a service attribute with a contents that can fit into an 32-bit integer.
-                *
-                *  \param name    Name of the attribute (used to identify the attribute variable only)
-                *  \param type    Type of attribute contents, a value from the \ref ServiceDiscovery_DataTypes_t enum
-                *  \param size    Size of the data, in bytes
-                *  \param ...     Data to associate with the attribute
+               /** 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.
                  */
                  */
-               #define SERVICE_ATTRIBUTE_LEN32(name, type, size, ...) const ServiceAttributeData32Bit_t name PROGMEM = \
-                                                                      {.Header = (type | 7), .Size = size, .Data = __VA_ARGS__}
-
-               /** Terminator for a service attribute table of type \ref ServiceAttributeTable_t. */
-               #define SERVICE_ATTRIBUTE_TABLE_TERMINATOR      {.Data = NULL}
-
-       /* Enums: */
                 enum ServiceDiscovery_DataTypes_t
                 {
                 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: */
                 };
  
         /* 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
                 {
                 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;
                 
                 } SDP_PDUHeader_t;
                 
-               typedef struct
+       /* 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
+                */
+               static inline void SDP_WriteData8(void** BufferPos, uint8_t Data)
                 {
                 {
-                       uint16_t    AttributeID;
-                       const void* Data;
-               } ServiceAttributeTable_t;
-
-               typedef struct
+                       *((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)
                 {
                 {
-                       uint8_t UUID[16];
-                       const void* AttributeTable;
-               } ServiceTable_t;
+                       *((uint16_t*)*BufferPos) = SwapEndian_16(Data);
+                       *BufferPos += sizeof(uint16_t);
+               }               
  
  
-               typedef struct
+               /** 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
+                */
+               static inline void SDP_WriteData32(void** BufferPos, uint32_t Data)
                 {
                 {
-                       uint8_t  Header;
-                       uint32_t Size;
-                       uint8_t  Data[];
-               } ServiceAttributeData32Bit_t;
+                       *((uint32_t*)*BufferPos) = SwapEndian_32(Data);
+                       *BufferPos += sizeof(uint32_t);
+               }
  
  
-               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;
-                       uint16_t Size;
-                       uint8_t  Data[];
-               } ServiceAttributeData16Bit_t;
+                       uint8_t Data = *((uint8_t*)*BufferPos);
+                       *BufferPos += sizeof(uint8_t);
+                       
+                       return Data;
+               }
  
  
-               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;
-                       uint8_t Size;
-                       uint8_t Data[];
-               } ServiceAttributeData8Bit_t;
+                       uint16_t Data = SwapEndian_16(*((uint16_t*)*BufferPos));
+                       *BufferPos += sizeof(uint16_t);
+                       
+                       return Data;
+               }
  
  
-               typedef struct
+               /** 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)
                 {
                 {
-                       uint8_t Header;
-                       uint8_t Data[];
-               } ServiceAttributeData_t;
+                       uint32_t Data = SwapEndian_32(*((uint32_t*)*BufferPos));
+                       *BufferPos += sizeof(uint32_t);
+                       
+                       return Data;
+               }
  
  
-       /* Inline Functions: */
-               static inline uint16_t* ServiceDiscovery_AddDataElementHeader(uint8_t** BufferPos, const uint8_t Type)
+               /** 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.
+                *
+                *  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
+                */
+               static inline uint16_t* SDP_AddSequence16(void** BufferPos)
                 {
                 {
-                       **BufferPos = (6 | Type);       
-                       *BufferPos += 1;
+                       SDP_WriteData8(BufferPos, (SDP_DATASIZE_Variable16Bit | SDP_DATATYPE_Sequence));
  
  
-                       uint16_t* SizePos = (uint16_t*)*BufferPos;                              
-                       *SizePos = 0;
+                       uint16_t* SizePos = *BufferPos;                 
+                       SDP_WriteData16(BufferPos, 0);
  
  
-                       **BufferPos += 2;
-                       
                         return SizePos;
                 }
                         return SizePos;
                 }
-
-               static inline uint16_t ServiceDiscovery_Read16BitParameter(const void** AttributeHeader)
-               {
-                       uint16_t ParamValue = *((uint16_t*)*AttributeHeader);
-                       *AttributeHeader += sizeof(uint16_t);
-                       return ParamValue;
-               }
                 
         /* Function Prototypes: */
                 
         /* Function Prototypes: */
-               void ServiceDiscovery_ProcessPacket(void* Data, Bluetooth_Channel_t* Channel);
+               void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);
  
                 #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
  
                 #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
-                       static void ServiceDiscovery_ProcessServiceSearch(SDP_PDUHeader_t* SDPHeader, Bluetooth_Channel_t* Channel);
-                       static void ServiceDiscovery_ProcessServiceAttribute(SDP_PDUHeader_t* SDPHeader, Bluetooth_Channel_t* Channel);
-                       static void ServiceDiscovery_ProcessServiceSearchAttribute(SDP_PDUHeader_t* SDPHeader, Bluetooth_Channel_t* Channel);
-
-                       static uint8_t ServiceDiscovery_ProcessAttributes(uint8_t UUIDList[][UUID_SIZE_BYTES], const uint8_t TotalUUIDs, 
-                                                                         uint8_t* ResponseBuffer, uint8_t MaxResponseSize,
-                                                                         const void** CurrentParameter);
-                       static uint8_t ServiceDiscovery_GetAttribute(uint8_t UUIDList[][UUID_SIZE_BYTES], const uint8_t TotalUUIDs,
-                                                                    const uint32_t Attribute, uint8_t** DataBuffer, uint8_t BufferLen);
-                       static uint8_t ServiceDiscovery_GetUUIDList(uint8_t UUIDList[][UUID_SIZE_BYTES], const void** CurrentParameter);
-                       static uint32_t ServiceDiscovery_GetDataElementSize(const void** AttributeHeader, uint8_t* ElementHeaderSize);
+                       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 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);
+
+                       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, uint8_t* const HeaderSize);
+                       static uint32_t SDP_GetDataElementSize(const void** const AttributeHeader, uint8_t* const ElementHeaderSize);
                 #endif
  
  #endif
                 #endif
  
  #endif