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_NAME                  (0x0000 + SDP_ATTRIBUTE_LANGOFFSET)
  62                 #define SDP_ATTRIBUTE_ID_DESCRIPTION           (0x0001 + SDP_ATTRIBUTE_LANGOFFSET)
  63
  64                 /** Attribute ID offset for localised language string attributes. */
  65                 #define SDP_ATTRIBUTE_LANGOFFSET                0x0100
  66
  67                 /** Size of a full 128 bit UUID, in bytes. */
  68                 #define UUID_SIZE_BYTES                         16
  69
  70                 /** First 96 bits common to all standadized Bluetooth services. */
  71                 #define BASE_96BIT_UUID                         0xFB, 0x34, 0x9B, 0x5F, 0x80, 0x00, 0x00, 0x80, 0x00, 0x10, 0x00, 0x00
  72
  73                 /** Terminator for a service attribute table of type \ref ServiceAttributeTable_t. */
  74                 #define SERVICE_ATTRIBUTE_TABLE_TERMINATOR      {.Data = NULL}
  75
  76         /* Enums: */
  77                 enum ServiceDiscovery_DataTypes_t
  78                 {
  79                         SDP_DATATYPE_Nill        = (0 << 3),
  80                         SDP_DATATYPE_UnsignedInt = (1 << 3),
  81                         SDP_DATATYPE_SignedInt   = (2 << 3),
  82                         SDP_DATATYPE_UUID        = (3 << 3),
  83                         SDP_DATATYPE_String      = (4 << 3),
  84                         SDP_DATATYPE_Boolean     = (5 << 3),
  85                         SDP_DATATYPE_Sequence    = (6 << 3),
  86                         SDP_DATATYPE_Alternative = (7 << 3),
  87                         SDP_DATATYPE_URL         = (8 << 3),
  88                 };
  89
  90         /* Type Defines: */
  91                 typedef struct
  92                 {
  93                         uint8_t  PDU;
  94                         uint16_t TransactionID;
  95                         uint16_t ParameterLength;
  96                 } SDP_PDUHeader_t;
  97
  98                 typedef struct
  99                 {
 100                         uint16_t    AttributeID;
 101                         const void* Data;
 102                 } ServiceAttributeTable_t;
 103
 104                 typedef struct
 105                 {
 106                         uint8_t UUID[16];
 107                         const void* AttributeTable;
 108                 } ServiceTable_t;
 109
 110                 typedef struct
 111                 {
 112                         uint8_t  Header;
 113                         uint8_t  Size;
 114                         uint16_t UUID[UUID_SIZE_BYTES];
 115                 } ClassUUID_t;
 116
 117         /* Inline Functions: */
 118                 /** Adds a new Data Element container of the given type with a 16-bit size header to the buffer. The
 119                  *  buffer pointer's position is advanced past the added header once the element has been added. The
 120                  *  returned size header value is pre-zeroed out so that it can be incremented as data is placed into
 121                  *  the Data Element container.
 122                  *
 123                  *  The total added size of the container header is three bytes, regardless of the size of its contents
 124                  *  as long as the contents' size in bytes fits into a 16-bit integer.
 125                  *
 126                  *  \param[in, out] BufferPos  Pointer to a buffer where the container header is to be placed
 127                  *  \param[in]      Type       Type of data the container is to store, a value from the \ref ServiceDiscovery_DataTypes_t enum
 128                  *
 129                  *  \return Pointer to the 16-bit size value of the contaner header, which has been pre-zeroed
 130                  */
 131                 static inline uint16_t* SDP_AddDataElementHeader16(uint8_t** BufferPos, const uint8_t Type)
 132                 {
 133                         **BufferPos = (6 | Type);
 134
 135                         uint16_t* SizePos = (uint16_t*)*(BufferPos + 1);
 136                         *SizePos = 0;
 137
 138                         *BufferPos += 3;
 139                         return SizePos;
 140                 }
 141
 142         /* Function Prototypes: */
 143                 void SDP_ProcessPacket(void* Data, Bluetooth_Channel_t* Channel);
 144
 145                 #if defined(INCLUDE_FROM_SERVICEDISCOVERYPROTOCOL_C)
 146                         static void SDP_ProcessServiceSearch(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 147                         static void SDP_ProcessServiceAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 148                         static void SDP_ProcessServiceSearchAttribute(const SDP_PDUHeader_t* const SDPHeader, Bluetooth_Channel_t* const Channel);
 149
 150                         static void* SDP_GetAttributeValue(const ServiceAttributeTable_t* AttributeTable, const uint16_t AttributeID);
 151                         static ServiceAttributeTable_t* SDP_GetAttributeTable(const uint8_t* const UUID);
 152                         static uint8_t SDP_GetAttributeList(uint16_t AttributeList[][2], const void** const CurrentParameter);
 153                         static uint8_t SDP_GetUUIDList(uint8_t UUIDList[][UUID_SIZE_BYTES], const void** const CurrentParameter);
 154                         static uint32_t SDP_GetLocalAttributeContainerSize(const void* const AttributeData);
 155                         static uint32_t SDP_GetDataElementSize(const void** const AttributeHeader, uint8_t* const ElementHeaderSize);
 156                 #endif
 157
 158 #endif