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