Demos/Host/Incomplete/BluetoothHost/Lib/SDP.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for ServiceDiscoveryProtocol.c.
  34  */
  35
  36 #ifndef _SERVICEDISCOVERYPROTOCOL_H_
  37 #define _SERVICEDISCOVERYPROTOCOL_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/pgmspace.h>
  42                 #include <string.h>
  43                 #include <stdbool.h>
  44                 #include <stdio.h>
  45
  46                 #include <LUFA/Common/Common.h>
  47                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  48
  49                 #include "BluetoothStack.h"
  50                 #include "SDPServices.h"
  51
  52         /* Macros: */
  53                 #define BT_SDP_DEBUG(l, s, ...)                 do { if (SDP_DEBUG_LEVEL >= l) printf_P(PSTR("(SDP) " s "\r\n"), ##__VA_ARGS__); } while (0)
  54                 #define SDP_DEBUG_LEVEL                         0
  55
  56                 #define SDP_PDU_ERRORRESPONSE                   0x01
  57                 #define SDP_PDU_SERVICESEARCHREQUEST            0x02
  58                 #define SDP_PDU_SERVICESEARCHRESPONSE           0x03
  59                 #define SDP_PDU_SERVICEATTRIBUTEREQUEST         0x04
  60                 #define SDP_PDU_SERVICEATTRIBUTERESPONSE        0x05
  61                 #define SDP_PDU_SERVICESEARCHATTRIBUTEREQUEST   0x06
  62                 #define SDP_PDU_SERVICESEARCHATTRIBUTERESPONSE  0x07
  63
  64         /* Enums: */
  65                 /** Data sizes for SDP Data Element headers, to indicate the size of the data contained in the element. When creating
  66                  *  a Data Element, a value from this enum should be ORed with a value from the \ref ServiceDiscovery_DataTypes_t enum.
  67                  */
  68                 enum ServiceDiscovery_DataSizes_t
  69                 {
  70                         SDP_DATASIZE_8Bit          = 0, /**< Contained data is 8 bits in length. */
  71                         SDP_DATASIZE_16Bit         = 1, /**< Contained data is 16 bits in length. */
  72                         SDP_DATASIZE_32Bit         = 2, /**< Contained data is 32 bits in length. */
  73                         SDP_DATASIZE_64Bit         = 3, /**< Contained data is 64 bits in length. */
  74                         SDP_DATASIZE_128Bit        = 4, /**< Contained data is 128 bits in length. */
  75                         SDP_DATASIZE_Variable8Bit  = 5, /**< Contained data is encoded in an 8 bit size integer following the header. */
  76                         SDP_DATASIZE_Variable16Bit = 6, /**< Contained data is encoded in an 16 bit size integer following the header. */
  77                         SDP_DATASIZE_Variable32Bit = 7, /**< Contained data is encoded in an 32 bit size integer following the header. */
  78                 };
  79
  80                 /** Data types for SDP Data Element headers, to indicate the type of data contained in the element. When creating
  81                  *  a Data Element, a value from this enum should be ORed with a value from the \ref ServiceDiscovery_DataSizes_t enum.
  82                  */
  83                 enum ServiceDiscovery_DataTypes_t
  84                 {
  85                         SDP_DATATYPE_Nill        = (0 << 3), /**< Indicates the container data is a Nill (null) type. */
  86                         SDP_DATATYPE_UnsignedInt = (1 << 3), /**< Indicates the container data is an unsigned integer. */
  87                         SDP_DATATYPE_SignedInt   = (2 << 3), /**< Indicates the container data is a signed integer. */
  88                         SDP_DATATYPE_UUID        = (3 << 3), /**< Indicates the container data is a UUID. */
  89                         SDP_DATATYPE_String      = (4 << 3), /**< Indicates the container data is an ASCII string. */
  90                         SDP_DATATYPE_Boolean     = (5 << 3), /**< Indicates the container data is a logical boolean. */
  91                         SDP_DATATYPE_Sequence    = (6 << 3), /**< Indicates the container data is a sequence of containers. */
  92                         SDP_DATATYPE_Alternative = (7 << 3), /**< Indicates the container data is a sequence of alternative containers. */
  93                         SDP_DATATYPE_URL         = (8 << 3), /**< Indicates the container data is a URL. */
  94                 };
  95
  96         /* Type Defines: */
  97                 /** Header for all SPD transaction packets. This header is sent at the start of all SDP packets sent to or from a SDP
  98                  *  server.
  99                  */
 100                 typedef struct
 101                 {
 102                         uint8_t  PDU; /**< SDP packet type, a SDP_PDU_* mask value */
 103                         uint16_t TransactionID; /**< Unique transaction ID number to associate requests and responses */
 104                         uint16_t ParameterLength; /**< Length of the data following the SDP header */
 105                 } SDP_PDUHeader_t;
 106
 107         /* Inline Functions: */
 108                 /** Writes 8 bits of raw data to the given buffer, incrementing the buffer position afterwards.
 109                  *
 110                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
 111                  *  \param[in]      Data       Data to write to the buffer
 112                  */
 113                 static inline void SDP_WriteData8(void** BufferPos,
 114                                                   const uint8_t Data)
 115                 {
 116                         *((uint8_t*)*BufferPos) = Data;
 117                         *BufferPos += sizeof(uint8_t);
 118                 }
 119
 120                 /** Writes 16 bits of raw data to the given buffer, incrementing the buffer position afterwards.
 121                  *
 122                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
 123                  *  \param[in]      Data       Data to write to the buffer
 124                  */
 125                 static inline void SDP_WriteData16(void** BufferPos,
 126                                                    const uint16_t Data)
 127                 {
 128                         *((uint16_t*)*BufferPos) = SwapEndian_16(Data);
 129                         *BufferPos += sizeof(uint16_t);
 130                 }
 131
 132                 /** Writes 32 bits of raw data to the given buffer, incrementing the buffer position afterwards.
 133                  *
 134                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
 135                  *  \param[in]      Data       Data to write to the buffer
 136                  */
 137                 static inline void SDP_WriteData32(void** BufferPos,
 138                                                    const uint32_t Data)
 139                 {
 140                         *((uint32_t*)*BufferPos) = SwapEndian_32(Data);
 141                         *BufferPos += sizeof(uint32_t);
 142                 }
 143
 144                 /** Reads 8 bits of raw data from the given buffer, incrementing the buffer position afterwards.
 145                  *
 146                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
 147                  *
 148                  *  \return Data read from the buffer
 149                  */
 150                 static inline uint8_t SDP_ReadData8(const void** BufferPos)
 151                 {
 152                         uint8_t Data = *((const uint8_t*)*BufferPos);
 153                         *BufferPos += sizeof(uint8_t);
 154
 155                         return Data;
 156                 }
 157
 158                 /** Reads 16 bits of raw data from the given buffer, incrementing the buffer position afterwards.
 159                  *
 160                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
 161                  *
 162                  *  \return Data read from the buffer
 163                  */
 164                 static inline uint16_t SDP_ReadData16(const void** BufferPos)
 165                 {
 166                         uint16_t Data = SwapEndian_16(*((const uint16_t*)*BufferPos));
 167                         *BufferPos += sizeof(uint16_t);
 168
 169                         return Data;
 170                 }
 171
 172                 /** Reads 32 bits of raw data from the given buffer, incrementing the buffer position afterwards.
 173                  *
 174                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
 175                  *
 176                  *  \return Data read from the buffer
 177                  */
 178                 static inline uint32_t SDP_ReadData32(const void** BufferPos)
 179                 {
 180                         uint32_t Data = SwapEndian_32(*((const uint32_t*)*BufferPos));
 181                         *BufferPos += sizeof(uint32_t);
 182
 183                         return Data;
 184                 }
 185
 186                 /** Adds a new Data Element Sequence container with a 16-bit size header to the buffer. The buffer
 187                  *  pointer's position is advanced past the added header once the element has been added. The returned
 188                  *  size header value is pre-zeroed out so that it can be incremented as data is placed into the Data
 189                  *  Element Sequence container.
 190                  *
 191                  *  The total added size of the container header is three bytes, regardless of the size of its contents
 192                  *  as long as the contents' size in bytes fits into a 16-bit integer.
 193                  *
 194                  *  \param[in, out] BufferPos  Pointer to a buffer where the container header is to be placed
 195                  *
 196                  *  \return Pointer to the 16-bit size value of the container header, which has been pre-zeroed
 197                  */
 198                 static inline uint16_t* SDP_AddSequence16(void** BufferPos)
 199                 {
 200                         SDP_WriteData8(BufferPos, (SDP_DATASIZE_Variable16Bit | SDP_DATATYPE_Sequence));
 201
 202                         uint16_t* SizePos = *BufferPos;
 203                         SDP_WriteData16(BufferPos, 0);
 204
 205                         return SizePos;
 206                 }
 207
 208         /* Function Prototypes: */
 209                 void SDP_ProcessPacket(void* Data,
 210                                        Bluetooth_Channel_t* const Channel);
 211
 212                 #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
 213                         static void     SDP_ProcessServiceSearch(const SDP_PDUHeader_t* const SDPHeader,
 214                                                                  Bluetooth_Channel_t* const Channel);
 215                         static void     SDP_ProcessServiceAttribute(const SDP_PDUHeader_t* const SDPHeader,
 216                                                                     Bluetooth_Channel_t* const Channel);
 217                         static void     SDP_ProcessServiceSearchAttribute(const SDP_PDUHeader_t* const SDPHeader,
 218                                                                           Bluetooth_Channel_t* const Channel);
 219
 220                         static uint16_t SDP_AddListedAttributesToResponse(const ServiceAttributeTable_t* AttributeTable,
 221                                                                           uint16_t AttributeList[][2],
 222                                                                           const uint8_t TotalAttributes,
 223                                                                           void** const BufferPos);
 224                         static uint16_t SDP_AddAttributeToResponse(const uint16_t AttributeID,
 225                                                                    const void* AttributeValue,
 226                                                                    void** ResponseBuffer);
 227                         static void*    SDP_GetAttributeValue(const ServiceAttributeTable_t* AttributeTable,
 228                                                               const uint16_t AttributeID);
 229
 230                         static bool     SDP_SearchServiceTable(uint8_t UUIDList[][UUID_SIZE_BYTES],
 231                                                                const uint8_t TotalUUIDs,
 232                                                                const ServiceAttributeTable_t* CurrAttributeTable);
 233                         static void     SDP_CheckUUIDMatch(uint8_t UUIDList[][UUID_SIZE_BYTES],
 234                                                            const uint8_t TotalUUIDs,
 235                                                            uint16_t* const UUIDMatchFlags,
 236                                                            const void* CurrAttribute);
 237
 238                         static uint8_t  SDP_GetAttributeList(uint16_t AttributeList[][2],
 239                                                              const void** const CurrentParameter);
 240                         static uint8_t  SDP_GetUUIDList(uint8_t UUIDList[][UUID_SIZE_BYTES],
 241                                                         const void** const CurrentParameter);
 242
 243                         static uint32_t SDP_GetLocalAttributeContainerSize(const void* const AttributeData,
 244                                                                            uint8_t* const HeaderSize);
 245                         static uint32_t SDP_GetDataElementSize(const void** const AttributeHeader,
 246                                                                uint8_t* const ElementHeaderSize);
 247                 #endif
 248
 249 #endif