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 #ifndef _SERVICEDISCOVERYPROTOCOL_H_
  32 #define _SERVICEDISCOVERYPROTOCOL_H_
  33
  34         /* Includes: */
  35                 #include <avr/io.h>
  36                 #include <string.h>
  37                 #include <stdbool.h>
  38                 #include <stdio.h>
  39
  40                 #include <LUFA/Common/Common.h>
  41                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  42
  43                 #include "BluetoothStack.h"
  44
  45         /* Macros: */
  46                 #define BT_SDP_DEBUG(l, s, ...)                 do { if (SDP_DEBUG_LEVEL >= l) printf_P(PSTR("(SDP) " s "\r\n"), ##__VA_ARGS__); } while (0)
  47                 #define SDP_DEBUG_LEVEL                         2
  48
  49                 #define SDP_PDU_ERRORRESPONSE                   0x01
  50                 #define SDP_PDU_SERVICESEARCHREQUEST            0x02
  51                 #define SDP_PDU_SERVICESEARCHRESPONSE           0x03
  52                 #define SDP_PDU_SERVICEATTRIBUTEREQUEST         0x04
  53                 #define SDP_PDU_SERVICEATTRIBUTERESPONSE        0x05
  54                 #define SDP_PDU_SERVICESEARCHATTRIBUTEREQUEST   0x06
  55                 #define SDP_PDU_SERVICESEARCHATTRIBUTERESPONSE  0x07
  56
  57                 #define SDP_ATTRIBUTE_ID_SERVICERECORDHANDLE    0x0000
  58                 #define SDP_ATTRIBUTE_ID_SERVICECLASSIDS        0x0001
  59                 #define SDP_ATTRIBUTE_ID_LANGIDOFFSET           0x0006
  60                 #define SDP_ATTRIBUTE_ID_AVAILABILITY           0x0008
  61                 #define SDP_ATTRIBUTE_ID_VERSION                0x0200
  62                 #define SDP_ATTRIBUTE_ID_SERVICENAME            0x0100
  63                 #define SDP_ATTRIBUTE_ID_SERVICEDESCRIPTION     0x0101
  64
  65                 #define SWAPENDIAN_16(x)                        ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8))
  66                 #define SWAPENDIAN_32(x)                        (SWAPENDIAN_16(((x) & 0xFFFF0000) >> 16) | SWAPENDIAN_16(((x) & 0x0000FFFF) << 16))
  67
  68                 /** Size of a full 128 bit UUID, in bytes. */
  69                 #define UUID_SIZE_BYTES                         16
  70
  71                 /** First 96 bits common to all standadized Bluetooth services. */
  72                 #define BASE_96BIT_UUID                         0xFB, 0x34, 0x9B, 0x5F, 0x80, 0x00, 0x00, 0x80, 0x00, 0x10, 0x00, 0x00
  73
  74                 /** Terminator for a service attribute table of type \ref ServiceAttributeTable_t. */
  75                 #define SERVICE_ATTRIBUTE_TABLE_TERMINATOR      {.Data = NULL}
  76
  77         /* Enums: */
  78                 /** Data sizes for SDP Data Element headers, to indicate the size of the data contained in the element. When creating
  79                  *  a Data Element, a value from this enum should be ORed with a value from the \ref ServiceDiscovery_DataTypes_t enum.
  80                  */
  81                 enum ServiceDiscovery_DataSizes_t
  82                 {
  83                         SDP_DATASIZE_8Bit          = 0, /**< Contained data is 8 bits in length. */
  84                         SDP_DATASIZE_16Bit         = 1, /**< Contained data is 16 bits in length. */
  85                         SDP_DATASIZE_32Bit         = 2, /**< Contained data is 32 bits in length. */
  86                         SDP_DATASIZE_64Bit         = 3, /**< Contained data is 64 bits in length. */
  87                         SDP_DATASIZE_128Bit        = 4, /**< Contained data is 128 bits in length. */
  88                         SDP_DATASIZE_Variable8Bit  = 5, /**< Contained data is encoded in an 8 bit size integer following the header. */
  89                         SDP_DATASIZE_Variable16Bit = 6, /**< Contained data is encoded in an 16 bit size integer following the header. */
  90                         SDP_DATASIZE_Variable32Bit = 7, /**< Contained data is encoded in an 32 bit size integer following the header. */
  91                 };
  92
  93                 /** Data types for SDP Data Element headers, to indicate the type of data contained in the element. When creating
  94                  *  a Data Element, a value from this enum should be ORed with a value from the \ref ServiceDiscovery_DataSizes_t enum.
  95                  */
  96                 enum ServiceDiscovery_DataTypes_t
  97                 {
  98                         SDP_DATATYPE_Nill        = (0 << 3), /**< Indicates the container data is a Nill (null) type. */
  99                         SDP_DATATYPE_UnsignedInt = (1 << 3), /**< Indicates the container data is an unsigned integer. */
 100                         SDP_DATATYPE_SignedInt   = (2 << 3), /**< Indicates the container data is a signed integer. */
 101                         SDP_DATATYPE_UUID        = (3 << 3), /**< Indicates the container data is a UUID. */
 102                         SDP_DATATYPE_String      = (4 << 3), /**< Indicates the container data is an ASCII string. */
 103                         SDP_DATATYPE_Boolean     = (5 << 3), /**< Indicates the container data is a logical boolean. */
 104                         SDP_DATATYPE_Sequence    = (6 << 3), /**< Indicates the container data is a sequence of containers. */
 105                         SDP_DATATYPE_Alternative = (7 << 3), /**< Indicates the container data is a sequence of alternative containers. */
 106                         SDP_DATATYPE_URL         = (8 << 3), /**< Indicates the container data is a URL. */
 107                 };
 108
 109         /* Type Defines: */
 110                 /** Header for all SPD transaction packets. This header is sent at the start of all SDP packets sent to or from a SDP
 111                  *  server.
 112                  */
 113                 typedef struct
 114                 {
 115                         uint8_t  PDU; /**< SDP packet type, a SDP_PDU_* mask value */
 116                         uint16_t TransactionID; /**< Unique transaction ID number to associate requests and responses */
 117                         uint16_t ParameterLength; /**< Length of the data following the SDP header */
 118                 } SDP_PDUHeader_t;
 119
 120                 /** Structure for the association of attribute ID values to an attribute value in FLASH. A table of these
 121                  *  structures can then be built up for each supported UUID service within the device.
 122                  */
 123                 typedef struct
 124                 {
 125                         uint16_t    AttributeID; /**< Attribute ID of the table element which the UUID service supports */
 126                         const void* Data; /**< Pointer to the attribute data, located in PROGMEM memory space */
 127                 } ServiceAttributeTable_t;
 128
 129                 /** Structure for the association of service UUID values to attribute tables stored in FLASH. A table of these
 130                  *  structures can then be built up for each supported UUID service within the device.
 131                  */
 132                 typedef struct
 133                 {
 134                         uint8_t     UUID[UUID_SIZE_BYTES]; /**< UUID of a service supported by the device */
 135                         const void* AttributeTable; /**< Pointer to the UUID's attribute table, located in PROGMEM memory space */
 136                 } ServiceTable_t;
 137
 138                 /** Structure for a list of Data Elements containing UUIDs, for service attributes requiring UUID lists. */
 139                 typedef struct
 140                 {
 141                         uint8_t Header; /**< Data Element header, should be (SDP_DATATYPE_UUID | SDP_DATASIZE_128Bit) */
 142                         uint8_t UUID[UUID_SIZE_BYTES]; /**< UUID to store in the list Data Element */
 143                 } ClassUUID_t;
 144
 145                 /** Structure for a list of Data Elements containing 8-bit integers, for service attributes requiring such lists. */
 146                 typedef struct
 147                 {
 148                         uint8_t  Header; /**< Data Element header, should be (SDP_DATATYPE_UnsignedInt | SDP_DATASIZE_8Bit) */
 149                         uint8_t Value; /**< Value to store in the list Data Element */
 150                 } Item8Bit_t;
 151
 152                 /** Structure for a list of Data Elements containing 16-bit integers, for service attributes requiring such lists. */
 153                 typedef struct
 154                 {
 155                         uint8_t  Header; /**< Data Element header, should be (SDP_DATATYPE_UnsignedInt | SDP_DATASIZE_16Bit) */
 156                         uint16_t Value; /**< Value to store in the list Data Element */
 157                 } Item16Bit_t;
 158
 159                 /** Structure for a list of Data Elements containing 32-bit integers, for service attributes requiring such lists. */
 160                 typedef struct
 161                 {
 162                         uint8_t  Header; /**< Data Element header, should be (SDP_DATATYPE_UnsignedInt | SDP_DATASIZE_32Bit) */
 163                         uint32_t Value; /**< Value to store in the list Data Element */
 164                 } Item32Bit_t;
 165
 166         /* Inline Functions: */
 167                 /** Adds a new Data Element container of the given type with a 16-bit size header to the buffer. The
 168                  *  buffer pointer's position is advanced past the added header once the element has been added. The
 169                  *  returned size header value is pre-zeroed out so that it can be incremented as data is placed into
 170                  *  the Data Element container.
 171                  *
 172                  *  The total added size of the container header is three bytes, regardless of the size of its contents
 173                  *  as long as the contents' size in bytes fits into a 16-bit integer.
 174                  *
 175                  *  \param[in, out] BufferPos  Pointer to a buffer where the container header is to be placed
 176                  *  \param[in]      Type       Type of data the container is to store, a value from the \ref ServiceDiscovery_DataTypes_t enum
 177                  *
 178                  *  \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed
 179                  */
 180                 static inline uint16_t* SDP_AddDataElementHeader16(void** BufferPos, const uint8_t Type)
 181                 {
 182                         *((uint8_t*)*BufferPos) = (SDP_DATASIZE_Variable16Bit | Type);
 183                         *BufferPos += sizeof(uint8_t);
 184
 185                         uint16_t* SizePos = (uint16_t*)*BufferPos;
 186                         *BufferPos += sizeof(uint16_t);
 187
 188                         *SizePos = 0;
 189                         return SizePos;
 190                 }
 191
 192         /* Function Prototypes: */
 193                 void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* Channel);
 194
 195                 #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
 196                         static void SDP_ProcessServiceSearch(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 197                         static void SDP_ProcessServiceAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 198                         static void SDP_ProcessServiceSearchAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 199
 200                         static uint16_t SDP_AddAttributeToResponse(const uint16_t AttributeID, const void* AttributeValue, void** ResponseBuffer);
 201                         static void*    SDP_GetAttributeValue(const ServiceAttributeTable_t* AttributeTable, const uint16_t AttributeID);
 202                         static ServiceAttributeTable_t* SDP_GetAttributeTable(const uint8_t* const UUID);
 203                         static uint8_t  SDP_GetAttributeList(uint16_t AttributeList[][2], const void** const CurrentParameter);
 204                         static uint8_t  SDP_GetUUIDList(uint8_t UUIDList[][UUID_SIZE_BYTES], const void** const CurrentParameter);
 205                         static uint32_t SDP_GetLocalAttributeContainerSize(const void* const AttributeData, uint8_t* const HeaderSize);
 206                         static uint32_t SDP_GetDataElementSize(const void** const AttributeHeader, uint8_t* const ElementHeaderSize);
 207                 #endif
 208
 209 #endif