Demos/Host/Incomplete/BluetoothHost/Lib/RFCOMM.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 RFCOMM.c.
  34  */
  35
  36 #ifndef _RFCOMM_H_
  37 #define _RFCOMM_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/pgmspace.h>
  42                 #include <string.h>
  43                 #include <stdbool.h>
  44                 #include <stdio.h>
  45
  46                 #include <LUFA/Common/Common.h>
  47                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  48
  49                 #include "BluetoothStack.h"
  50
  51         /* Macros: */
  52                 #define BT_RFCOMM_DEBUG(l, s, ...)              do { if (RFCOMM_DEBUG_LEVEL >= l) printf_P(PSTR("(RFCOMM) " s "\r\n"), ##__VA_ARGS__); } while (0)
  53                 #define RFCOMM_DEBUG_LEVEL                      2
  54
  55                 #define FRAME_POLL_FINAL                        (1 << 4)
  56
  57                 #define RFCOMM_CONTROL_DLCI                     0
  58
  59                 #define RFCOMM_MAX_OPEN_CHANNELS                5
  60
  61         /* Enums: */
  62                 /** Enum for the types of RFCOMM frames which can be exchanged on a Bluetooth channel. */
  63                 enum RFCOMM_Frame_Types_t
  64                 {
  65                         RFCOMM_Frame_DM    = 0x0F, /**< Disconnected Mode Field */
  66                         RFCOMM_Frame_DISC  = 0x43, /**< Disconnect Field */
  67                         RFCOMM_Frame_SABM  = 0x2F, /**< Set Asynchronous Balance Mode Field */
  68                         RFCOMM_Frame_UA    = 0x63, /**< Unnumbered Acknowledgement Field */
  69                         RFCOMM_Frame_UIH   = 0xEF, /**< Unnumbered Information with Header check Field */
  70                 };
  71
  72                 enum RFCOMM_Control_Commands_t
  73                 {
  74                         RFCOMM_Control_Test                    = (0x20 >> 2),
  75                         RFCOMM_Control_FlowControlEnable       = (0xA0 >> 2),
  76                         RFCOMM_Control_FlowControlDisable      = (0x60 >> 2),
  77                         RFCOMM_Control_ModemStatus             = (0xE0 >> 2),
  78                         RFCOMM_Control_RemotePortNegotiation   = (0x90 >> 2),
  79                         RFCOMM_Control_RemoteLineStatus        = (0x50 >> 2),
  80                         RFCOMM_Control_DLCParameterNegotiation = (0x80 >> 2),
  81                         RFCOMM_Control_NonSupportedCommand     = (0x10 >> 2),
  82                 };
  83
  84         /* Type Defines: */
  85                 typedef struct
  86                 {
  87                         unsigned char EA   : 1;
  88                         unsigned char CR   : 1;
  89                         unsigned char DLCI : 6;
  90                 } RFCOMM_Address_t;
  91
  92                 typedef struct
  93                 {
  94                         RFCOMM_Address_t Address;
  95                         uint8_t          Control;
  96                 } RFCOMM_Header_t;
  97
  98                 typedef struct
  99                 {
 100                         unsigned char EA      : 1;
 101                         unsigned char CR      : 1;
 102                         unsigned char Command : 6;
 103                 } RFCOMM_Command_t;
 104
 105                 typedef struct
 106                 {
 107                         uint8_t DLCI;
 108                         bool    Configured;
 109                 } RFCOMM_Channel_t;
 110
 111         /* Function Prototypes: */
 112                 void RFCOMM_Initialize(void);
 113                 void RFCOMM_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);
 114
 115                 #if defined(INCLUDE_FROM_RFCOMM_C)
 116                         static void RFCOMM_ProcessDM(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel);
 117                         static void RFCOMM_ProcessDISC(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel);
 118                         static void RFCOMM_ProcessSABM(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel);
 119                         static void RFCOMM_ProcessUA(const RFCOMM_Address_t* const FrameAddress, Bluetooth_Channel_t* const Channel);
 120                         static void RFCOMM_ProcessUIH(const RFCOMM_Address_t* const FrameAddress, const uint16_t FrameLength,
 121                                           const uint8_t* FrameData, Bluetooth_Channel_t* const Channel);
 122
 123                         static void RFCOMM_ProcessControlCommand(const uint8_t* Command, Bluetooth_Channel_t* const Channel);
 124
 125                         static void RFCOMM_SendFrame(const uint8_t DLCI, const bool CommandResponse, const uint8_t Control,
 126                                                      const uint16_t DataLen, const void* Data, Bluetooth_Channel_t* const Channel);
 127
 128                         static uint8_t  RFCOMM_GetFCSValue(const void* FrameStart, uint8_t Length);
 129                         static uint16_t RFCOMM_GetFrameDataLength(const uint8_t* const BufferPos);
 130
 131                         RFCOMM_Channel_t* RFCOMM_GetChannelData(const uint8_t DLCI);
 132                 #endif
 133
 134 #endif