Oops - light weight ring buffer documentation used \ref instead of \param to document...

[pub/USBasp.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 ce7d5f2..18592ec 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h
+++ b/Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.h
@@ -38,6 +38,7 @@
 
        /* Includes: */
                #include <avr/io.h>
 
        /* Includes: */
                #include <avr/io.h>

+               #include <avr/pgmspace.h>

                #include <string.h>
                #include <stdbool.h>
                #include <stdio.h>
                #include <string.h>
                #include <stdbool.h>
                #include <stdio.h>


@@ -50,7 +51,7 @@
                
        /* 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


@@ -59,6 +60,14 @@
                #define SDP_PDU_SERVICEATTRIBUTERESPONSE        0x05
                #define SDP_PDU_SERVICESEARCHATTRIBUTEREQUEST   0x06
                #define SDP_PDU_SERVICESEARCHATTRIBUTERESPONSE  0x07
                #define SDP_PDU_SERVICEATTRIBUTERESPONSE        0x05
                #define SDP_PDU_SERVICESEARCHATTRIBUTEREQUEST   0x06
                #define SDP_PDU_SERVICESEARCHATTRIBUTERESPONSE  0x07

+               
+               /** Convenience macro - read a pointer out of PROGMEM space.
+                *
+                *  \param[in] x  Address of the pointer to read
+                *
+                *  \return  Pointer retrieved from PROGMEM space
+                */
+               #define pgm_read_ptr(x)                         (void*)pgm_read_word(x)

 
        /* Enums: */
                /** Data sizes for SDP Data Element headers, to indicate the size of the data contained in the element. When creating
 
        /* Enums: */
                /** Data sizes for SDP Data Element headers, to indicate the size of the data contained in the element. When creating


@@ -104,44 +113,125 @@
                } SDP_PDUHeader_t;
                
        /* Inline Functions: */
                } SDP_PDUHeader_t;
                
        /* Inline Functions: */

-               /** 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.
+               /** 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)
+               {
+                       *((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);
+               }               
+
+               /** 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)
+               {
+                       *((uint32_t*)*BufferPos) = SwapEndian_32(Data);
+                       *BufferPos += sizeof(uint32_t);
+               }
+
+               /** 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 Data = *((uint8_t*)*BufferPos);
+                       *BufferPos += sizeof(uint8_t);
+                       
+                       return Data;
+               }
+
+               /** 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)
+               {
+                       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 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
                 *
                 *  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
                 */
                 *
                 *  \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed
                 */

-               static inline uint16_t* SDP_AddDataElementHeader16(void** BufferPos, const uint8_t Type)
+               static inline uint16_t* SDP_AddSequence16(void** BufferPos)

                {
                {

-                       *((uint8_t*)*BufferPos) = (SDP_DATASIZE_Variable16Bit | Type);
-                       *BufferPos += sizeof(uint8_t);
+                       SDP_WriteData8(BufferPos, (SDP_DATASIZE_Variable16Bit | SDP_DATATYPE_Sequence));

 
 

-                       uint16_t* SizePos = (uint16_t*)*BufferPos;
-                       *BufferPos += sizeof(uint16_t);
+                       uint16_t* SizePos = *BufferPos;                 
+                       SDP_WriteData16(BufferPos, 0);

 
 

-                       *SizePos = 0;

                        return SizePos;
                }
                
        /* Function Prototypes: */
                        return SizePos;
                }
                
        /* Function Prototypes: */

-               void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* Channel);
+               void SDP_Initialize(void);
+               void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);

 
                #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
 
                #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 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 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 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 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
                        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