Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothHCICommands.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 _BLUETOOTH_HCICOMMANDS_H_
  32 #define _BLUETOOTH_HCICOMMANDS_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/Drivers/USB/USB.h>
  41                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  42
  43                 #include "BluetoothStack.h"
  44                 #include "BluetoothClassCodes.h"
  45
  46         /* Macros: */
  47                 #define BT_HCI_DEBUG(l, s, ...)                        do { if (HCI_DEBUG_LEVEL >= l) printf_P(PSTR("(HCI) " s "\r\n"), __VA_ARGS__); } while (0)
  48                 #define HCI_DEBUG_LEVEL                                0
  49
  50                 #define OGF_LINK_CONTROL                               0x01
  51                 #define OGF_CTRLR_BASEBAND                             0x03
  52                 #define OGF_CTRLR_INFORMATIONAL                        0x04
  53
  54                 #define OCF_LINK_CONTROL_INQUIRY                       0x0001
  55                 #define OCF_LINK_CONTROL_INQUIRY_CANCEL                0x0002
  56                 #define OCF_LINK_CONTROL_PERIODIC_INQUIRY              0x0003
  57                 #define OCF_LINK_CONTROL_EXIT_PERIODIC_INQUIRY         0x0004
  58                 #define OCF_LINK_CONTROL_CREATE_CONNECTION             0x0005
  59                 #define OCF_LINK_CONTROL_DISCONNECT                    0x0006
  60                 #define OCF_LINK_CONTROL_CREATE_CONNECTION_CANCEL      0x0008
  61                 #define OCF_LINK_CONTROL_ACCEPT_CONNECTION_REQUEST     0x0009
  62                 #define OCF_LINK_CONTROL_REJECT_CONNECTION_REQUEST     0x000A
  63                 #define OCF_LINK_CONTROL_LINK_KEY_REQUEST_REPLY        0x000B
  64                 #define OCF_LINK_CONTROL_LINK_KEY_REQUEST_NEG_REPLY    0x000C
  65                 #define OCF_LINK_CONTROL_PIN_CODE_REQUEST_REPLY        0x000D
  66                 #define OCF_LINK_CONTROL_PIN_CODE_REQUEST_NEG_REPLY    0x000E
  67                 #define OCF_LINK_CONTROL_CHANGE_CONNECTION_PACKET_TYPE 0x000F
  68                 #define OCF_LINK_CONTROL_REMOTE_NAME_REQUEST           0x0019
  69                 #define OCF_CTRLR_BASEBAND_SET_EVENT_MASK              0x0001
  70                 #define OCF_CTRLR_BASEBAND_RESET                       0x0003
  71                 #define OCF_CTRLR_BASEBAND_WRITE_PIN_TYPE              0x000A
  72                 #define OCF_CTRLR_BASEBAND_WRITE_LOCAL_NAME            0x0013
  73                 #define OCF_CTRLR_BASEBAND_READ_LOCAL_NAME             0x0014
  74                 #define OCF_CTRLR_BASEBAND_WRITE_SCAN_ENABLE           0x001A
  75                 #define OCF_CTRLR_BASEBAND_WRITE_CLASS_OF_DEVICE       0x0024
  76                 #define OCF_CTRLR_BASEBAND_WRITE_SIMPLE_PAIRING_MODE   0x0056
  77                 #define OCF_CTRLR_BASEBAND_WRITE_AUTHENTICATION_ENABLE 0x0020
  78                 #define OGF_CTRLR_INFORMATIONAL_READBUFFERSIZE         0x0005
  79
  80                 #define EVENT_COMMAND_STATUS                           0x0F
  81                 #define EVENT_COMMAND_COMPLETE                         0x0E
  82                 #define EVENT_CONNECTION_COMPLETE                      0x03
  83                 #define EVENT_CONNECTION_REQUEST                       0x04
  84                 #define EVENT_DISCONNECTION_COMPLETE                   0x05
  85                 #define EVENT_REMOTE_NAME_REQUEST_COMPLETE             0x07
  86                 #define EVENT_PIN_CODE_REQUEST                         0x16
  87                 #define EVENT_LINK_KEY_REQUEST                         0x17
  88
  89                 #define ERROR_LIMITED_RESOURCES                        0x0D
  90                 #define ERROR_UNACCEPTABLE_BDADDR                      0x0F
  91
  92         /* Type Defines: */
  93                 typedef struct
  94                 {
  95                         struct
  96                         {
  97                                 int OCF : 10;
  98                                 int OGF : 6;
  99                         } OpCode;
 100
 101                         uint8_t  ParameterLength;
 102                         uint8_t  Parameters[];
 103                 } BT_HCICommand_Header_t;
 104
 105                 typedef struct
 106                 {
 107                         uint8_t  EventCode;
 108                         uint8_t  ParameterLength;
 109                 } BT_HCIEvent_Header_t;
 110
 111                 typedef struct
 112                 {
 113                         uint8_t Status;
 114                         uint8_t Packets;
 115
 116                         struct
 117                         {
 118                                 int OCF : 10;
 119                                 int OGF : 6;
 120                         } OpCode;
 121                 } BT_HCIEvent_CommandStatus_t;
 122
 123                 typedef struct
 124                 {
 125                         uint8_t  HCLPacketsAllowable;
 126                         uint16_t Opcode;
 127                         uint8_t  ReturnParams[];
 128                 } BT_HCIEvent_CommandComplete_t;
 129
 130                 typedef struct
 131                 {
 132                         uint8_t  RemoteAddress[6];
 133                         uint8_t  ClassOfDevice_Service;
 134                         uint16_t ClassOfDevice_MajorMinor;
 135                         uint8_t  LinkType;
 136                 } BT_HCIEvent_ConnectionRequest_t;
 137
 138                 typedef struct
 139                 {
 140                         uint8_t  Status;
 141                         uint16_t ConnectionHandle;
 142                         uint8_t  RemoteAddress[6];
 143                         uint8_t  LinkType;
 144                         uint8_t  EncryptionEnabled;
 145                 } BT_HCIEvent_ConnectionComplete_t;
 146
 147                 typedef struct
 148                 {
 149                         uint8_t  RemoteAddress[6];
 150                 } BT_HCIEvent_PinCodeReq_t;
 151
 152                 typedef struct
 153                 {
 154                         uint8_t  RemoteAddress[6];
 155                 } BT_HCIEvent_LinkKeyReq_t;
 156
 157                 typedef struct
 158                 {
 159                         uint8_t  RemoteAddress[6];
 160                 } BT_HCICommand_LinkKeyNAKResp_t;
 161
 162                 typedef struct
 163                 {
 164                         uint8_t  RemoteAddress[6];
 165                         uint8_t  PINCodeLength;
 166                         char     PINCode[16];
 167                 } BT_HCICommand_PinCodeResp_t;
 168
 169                 typedef struct
 170                 {
 171                         uint8_t  RemoteAddress[6];
 172                         uint8_t  SlaveRole;
 173                 } BT_HCICommand_AcceptConnectionReq_t;
 174
 175                 typedef struct
 176                 {
 177                         uint8_t  RemoteAddress[6];
 178                         uint8_t  Reason;
 179                 } BT_HCICommand_RejectConnectionReq_t;
 180
 181         /* Enums: */
 182                 enum BT_ScanEnable_Modes_t
 183                 {
 184                         BT_SCANMODE_NoScansEnabled       = 0,
 185                         BT_SCANMODE_InquiryScanOnly      = 1,
 186                         BT_SCANMODE_PageScanOnly         = 2,
 187                         BT_SCANMODE_InquiryAndPageScans  = 3,
 188                 };
 189
 190                 enum BT_HCIStates_t
 191                 {
 192                         Bluetooth_ProcessEvents          = 0,
 193                         Bluetooth_Init                   = 1,
 194                         Bluetooth_Init_Reset             = 2,
 195                         Bluetooth_Init_SetLocalName      = 3,
 196                         Bluetooth_Init_SetDeviceClass    = 4,
 197                         Bluetooth_Init_WriteScanEnable   = 5,
 198                         Bluetooth_Conn_AcceptConnection  = 6,
 199                         Bluetooth_Conn_RejectConnection  = 7,
 200                         Bluetooth_Conn_SendPINCode       = 8,
 201                         Bluetooth_Conn_SendLinkKeyNAK    = 9,
 202                 };
 203
 204         /* External Variables: */
 205                 extern uint8_t Bluetooth_HCIProcessingState;
 206
 207         /* Function Prototypes: */
 208                 void Bluetooth_HCITask(void);
 209
 210                 #if defined(INCLUDE_FROM_BLUETOOTHHCICOMMANDS_C)
 211                         static uint8_t Bluetooth_SendHCICommand(BT_HCICommand_Header_t* HCICommandHeader, void* Parameters,
 212                                                                 uint16_t ParameterLength);
 213                 #endif
 214
 215 #endif