Demos/Host/Incomplete/BluetoothHost/Lib/ServiceDiscoveryProtocol.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                 /** Convenience macro - read a pointer out of PROGMEM space.
  65                  *
  66                  *  \param[in] x  Address of the pointer to read
  67                  *
  68                  *  \return  Pointer retrieved from PROGMEM space
  69                  */
  70                 #define pgm_read_ptr(x)                         (void*)pgm_read_word(x)
  71
  72         /* Enums: */
  73                 /** Data sizes for SDP Data Element headers, to indicate the size of the data contained in the element. When creating
  74                  *  a Data Element, a value from this enum should be ORed with a value from the \ref ServiceDiscovery_DataTypes_t enum.
  75                  */
  76                 enum ServiceDiscovery_DataSizes_t
  77                 {
  78                         SDP_DATASIZE_8Bit          = 0, /**< Contained data is 8 bits in length. */
  79                         SDP_DATASIZE_16Bit         = 1, /**< Contained data is 16 bits in length. */
  80                         SDP_DATASIZE_32Bit         = 2, /**< Contained data is 32 bits in length. */
  81                         SDP_DATASIZE_64Bit         = 3, /**< Contained data is 64 bits in length. */
  82                         SDP_DATASIZE_128Bit        = 4, /**< Contained data is 128 bits in length. */
  83                         SDP_DATASIZE_Variable8Bit  = 5, /**< Contained data is encoded in an 8 bit size integer following the header. */
  84                         SDP_DATASIZE_Variable16Bit = 6, /**< Contained data is encoded in an 16 bit size integer following the header. */
  85                         SDP_DATASIZE_Variable32Bit = 7, /**< Contained data is encoded in an 32 bit size integer following the header. */
  86                 };
  87
  88                 /** Data types for SDP Data Element headers, to indicate the type of data contained in the element. When creating
  89                  *  a Data Element, a value from this enum should be ORed with a value from the \ref ServiceDiscovery_DataSizes_t enum.
  90                  */
  91                 enum ServiceDiscovery_DataTypes_t
  92                 {
  93                         SDP_DATATYPE_Nill        = (0 << 3), /**< Indicates the container data is a Nill (null) type. */
  94                         SDP_DATATYPE_UnsignedInt = (1 << 3), /**< Indicates the container data is an unsigned integer. */
  95                         SDP_DATATYPE_SignedInt   = (2 << 3), /**< Indicates the container data is a signed integer. */
  96                         SDP_DATATYPE_UUID        = (3 << 3), /**< Indicates the container data is a UUID. */
  97                         SDP_DATATYPE_String      = (4 << 3), /**< Indicates the container data is an ASCII string. */
  98                         SDP_DATATYPE_Boolean     = (5 << 3), /**< Indicates the container data is a logical boolean. */
  99                         SDP_DATATYPE_Sequence    = (6 << 3), /**< Indicates the container data is a sequence of containers. */
 100                         SDP_DATATYPE_Alternative = (7 << 3), /**< Indicates the container data is a sequence of alternative containers. */
 101                         SDP_DATATYPE_URL         = (8 << 3), /**< Indicates the container data is a URL. */
 102                 };
 103
 104         /* Type Defines: */
 105                 /** Header for all SPD transaction packets. This header is sent at the start of all SDP packets sent to or from a SDP
 106                  *  server.
 107                  */
 108                 typedef struct
 109                 {
 110                         uint8_t  PDU; /**< SDP packet type, a SDP_PDU_* mask value */
 111                         uint16_t TransactionID; /**< Unique transaction ID number to associate requests and responses */
 112                         uint16_t ParameterLength; /**< Length of the data following the SDP header */
 113                 } SDP_PDUHeader_t;
 114
 115         /* Inline Functions: */
 116                 /** Writes 8 bits of raw data to the given buffer, incrementing the buffer position afterwards.
 117                  *
 118                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
 119                  *  \param[in]      Data       Data to write to the buffer
 120                  */
 121                 static inline void SDP_WriteData8(void** BufferPos, uint8_t Data)
 122                 {
 123                         *((uint8_t*)*BufferPos) = Data;
 124                         *BufferPos += sizeof(uint8_t);
 125                 }
 126
 127                 /** Writes 16 bits of raw data to the given buffer, incrementing the buffer position afterwards.
 128                  *
 129                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
 130                  *  \param[in]      Data       Data to write to the buffer
 131                  */
 132                 static inline void SDP_WriteData16(void** BufferPos, uint16_t Data)
 133                 {
 134                         *((uint16_t*)*BufferPos) = SwapEndian_16(Data);
 135                         *BufferPos += sizeof(uint16_t);
 136                 }
 137
 138                 /** Writes 32 bits of raw data to the given buffer, incrementing the buffer position afterwards.
 139                  *
 140                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be written to
 141                  *  \param[in]      Data       Data to write to the buffer
 142                  */
 143                 static inline void SDP_WriteData32(void** BufferPos, uint32_t Data)
 144                 {
 145                         *((uint32_t*)*BufferPos) = SwapEndian_32(Data);
 146                         *BufferPos += sizeof(uint32_t);
 147                 }
 148
 149                 /** Reads 8 bits of raw data frpm the given buffer, incrementing the buffer position afterwards.
 150                  *
 151                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
 152                  *
 153                  *  \return Data read from the buffer
 154                  */
 155                 static inline uint8_t SDP_ReadData8(const void** BufferPos)
 156                 {
 157                         uint8_t Data = *((uint8_t*)*BufferPos);
 158                         *BufferPos += sizeof(uint8_t);
 159
 160                         return Data;
 161                 }
 162
 163                 /** Reads 16 bits of raw data frpm the given buffer, incrementing the buffer position afterwards.
 164                  *
 165                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
 166                  *
 167                  *  \return Data read from the buffer
 168                  */
 169                 static inline uint16_t SDP_ReadData16(const void** BufferPos)
 170                 {
 171                         uint16_t Data = SwapEndian_16(*((uint16_t*)*BufferPos));
 172                         *BufferPos += sizeof(uint16_t);
 173
 174                         return Data;
 175                 }
 176
 177                 /** Reads 32 bits of raw data frpm the given buffer, incrementing the buffer position afterwards.
 178                  *
 179                  *  \param[in, out] BufferPos  Current position in the buffer where the data is to be read from
 180                  *
 181                  *  \return Data read from the buffer
 182                  */
 183                 static inline uint32_t SDP_ReadData32(const void** BufferPos)
 184                 {
 185                         uint32_t Data = SwapEndian_32(*((uint32_t*)*BufferPos));
 186                         *BufferPos += sizeof(uint32_t);
 187
 188                         return Data;
 189                 }
 190
 191                 /** Adds a new Data Element Sequence container with a 16-bit size header to the buffer. The buffer
 192                  *  pointer's position is advanced past the added header once the element has been added. The returned
 193                  *  size header value is pre-zeroed out so that it can be incremented as data is placed into the Data
 194                  *  Element Sequence container.
 195                  *
 196                  *  The total added size of the container header is three bytes, regardless of the size of its contents
 197                  *  as long as the contents' size in bytes fits into a 16-bit integer.
 198                  *
 199                  *  \param[in, out] BufferPos  Pointer to a buffer where the container header is to be placed
 200                  *
 201                  *  \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed
 202                  */
 203                 static inline uint16_t* SDP_AddSequence16(void** BufferPos)
 204                 {
 205                         SDP_WriteData8(BufferPos, (SDP_DATASIZE_Variable16Bit | SDP_DATATYPE_Sequence));
 206
 207                         uint16_t* SizePos = *BufferPos;
 208                         SDP_WriteData16(BufferPos, 0);
 209
 210                         return SizePos;
 211                 }
 212
 213         /* Function Prototypes: */
 214                 void SDP_Initialize(void);
 215                 void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);
 216
 217                 #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
 218                         static void     SDP_ProcessServiceSearch(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 219                         static void     SDP_ProcessServiceAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 220                         static void     SDP_ProcessServiceSearchAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 221
 222                         static uint16_t SDP_AddListedAttributesToResponse(const ServiceAttributeTable_t* AttributeTable, uint16_t AttributeList[][2],
 223                                                                           const uint8_t TotalAttributes, void** const BufferPos);
 224                         static uint16_t SDP_AddAttributeToResponse(const uint16_t AttributeID, const void* AttributeValue, void** ResponseBuffer);
 225                         static void*    SDP_GetAttributeValue(const ServiceAttributeTable_t* AttributeTable, const uint16_t AttributeID);
 226
 227                         static bool     SDP_SearchServiceTable(uint8_t UUIDList[][UUID_SIZE_BYTES], const uint8_t TotalUUIDs,
 228                                                                const ServiceAttributeTable_t* CurrAttributeTable);
 229                         static void     SDP_CheckUUIDMatch(uint8_t UUIDList[][UUID_SIZE_BYTES], const uint8_t TotalUUIDs, bool UUIDMatch[],
 230                                                            const void* CurrAttribute);
 231
 232                         static uint8_t  SDP_GetAttributeList(uint16_t AttributeList[][2], const void** const CurrentParameter);
 233                         static uint8_t  SDP_GetUUIDList(uint8_t UUIDList[][UUID_SIZE_BYTES], const void** const CurrentParameter);
 234
 235                         static uint32_t SDP_GetLocalAttributeContainerSize(const void* const AttributeData, uint8_t* const HeaderSize);
 236                         static uint32_t SDP_GetDataElementSize(const void** const AttributeHeader, uint8_t* const ElementHeaderSize);
 237                 #endif
 238
 239 #endif