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