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                 #include "RFCOMMControl.h"
  51
  52         /* Macros: */
  53                 #define BT_RFCOMM_DEBUG(l, s, ...)              do { if (RFCOMM_DEBUG_LEVEL >= l) printf_P(PSTR("(RFCOMM) " s "\r\n"), ##__VA_ARGS__); } while (0)
  54                 #define RFCOMM_DEBUG_LEVEL                      0
  55
  56                 #define FRAME_POLL_FINAL                        (1 << 4)
  57
  58                 #define RFCOMM_CONTROL_DLCI                     0
  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_Channel_States_t
  73                 {
  74                         RFCOMM_Channel_Closed      = 0,
  75                         RFCOMM_Channel_Configure   = 1,
  76                         RFCOMM_Channel_Open        = 2,
  77                 };
  78
  79         /* Type Defines: */
  80                 typedef struct
  81                 {
  82                         uint8_t  DLCI;
  83                         uint8_t  State;
  84                         uint8_t  Priority;
  85                         uint16_t MTU;
  86                         uint8_t  ConfigFlags;
  87                         struct
  88                         {
  89                                 uint8_t Signals;
  90                                 uint8_t BreakSignal;
  91                         } Remote;
  92                         struct
  93                         {
  94                                 uint8_t Signals;
  95                                 uint8_t BreakSignal;
  96                         } Local;
  97                 } RFCOMM_Channel_t;
  98
  99         /* External Variables: */
 100                 extern RFCOMM_Channel_t RFCOMM_Channels[RFCOMM_MAX_OPEN_CHANNELS];
 101
 102         /* Function Prototypes: */
 103                 void              RFCOMM_Initialize(void);
 104                 void              RFCOMM_ServiceChannels(Bluetooth_Channel_t* const ACLChannel);
 105                 void              RFCOMM_ProcessPacket(void* Data,
 106                                                        Bluetooth_Channel_t* const ACLChannel);
 107
 108                 void              RFCOMM_SendChannelSignals(const RFCOMM_Channel_t* const RFCOMMChannel,
 109                                                             Bluetooth_Channel_t* const ACLChannel);
 110                 void              RFCOMM_SendData(const uint16_t DataLen,
 111                                                   const uint8_t* Data,
 112                                                   const RFCOMM_Channel_t* const RFCOMMChannel,
 113                                                   Bluetooth_Channel_t* const ACLChannel);
 114
 115                 void              RFCOMM_ChannelOpened(RFCOMM_Channel_t* const RFCOMMChannel);
 116                 void              RFCOMM_DataReceived(RFCOMM_Channel_t* const RFCOMMChannel,
 117                                                       uint16_t DataLen,
 118                                                       const uint8_t* Data);
 119                 void              RFCOMM_ChannelSignalsReceived(RFCOMM_Channel_t* const RFCOMMChannel);
 120
 121                 RFCOMM_Channel_t* RFCOMM_GetFreeChannelEntry(const uint8_t DLCI);
 122                 RFCOMM_Channel_t* RFCOMM_GetChannelData(const uint8_t DLCI);
 123                 uint16_t          RFCOMM_GetVariableFieldValue(const uint8_t** BufferPos);
 124                 void              RFCOMM_SendFrame(const uint8_t DLCI,
 125                                                    const bool CommandResponse,
 126                                                    const uint8_t Control,
 127                                                        const uint16_t DataLen,
 128                                                    const void* Data,
 129                                                    Bluetooth_Channel_t* const ACLChannel);
 130
 131                 #if defined(INCLUDE_FROM_RFCOMM_C)
 132                         static uint8_t RFCOMM_GetFCSValue(const void* FrameStart,
 133                                                           uint8_t Length);
 134
 135                         static void RFCOMM_ProcessDM(const RFCOMM_Address_t* const FrameAddress,
 136                                                      Bluetooth_Channel_t* const ACLChannel);
 137                         static void RFCOMM_ProcessDISC(const RFCOMM_Address_t* const FrameAddress,
 138                                                        Bluetooth_Channel_t* const ACLChannel);
 139                         static void RFCOMM_ProcessSABM(const RFCOMM_Address_t* const FrameAddress,
 140                                                        Bluetooth_Channel_t* const ACLChannel);
 141                         static void RFCOMM_ProcessUA(const RFCOMM_Address_t* const FrameAddress,
 142                                                      Bluetooth_Channel_t* const ACLChannel);
 143                         static void RFCOMM_ProcessUIH(const RFCOMM_Address_t* const FrameAddress,
 144                                                       const uint16_t FrameLength,
 145                                           const uint8_t* FrameData,
 146                                                       Bluetooth_Channel_t* const ACLChannel);
 147                 #endif
 148
 149 #endif