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