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                      2
  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_Create      = 1,
  76                         RFCOMM_Channel_Creating    = 2,
  77                         RFCOMM_Channel_Configure   = 3,
  78                         RFCOMM_Channel_Configuring = 4,
  79                         RFCOMM_Channel_Open        = 5,
  80                 };
  81
  82         /* Type Defines: */
  83                 typedef struct
  84                 {
  85                         uint8_t  DLCI;
  86                         uint8_t  State;
  87                         uint8_t  Priority;
  88                         uint16_t MTU;
  89                         struct
  90                         {
  91                                 uint8_t  Signals;
  92                                 uint8_t  BreakSignal;
  93                         } Remote;
  94                         struct
  95                         {
  96                                 uint8_t  Signals;
  97                                 uint8_t  BreakSignal;
  98                         } Local;
  99                 } RFCOMM_Channel_t;
 100
 101         /* External Variables: */
 102                 extern RFCOMM_Channel_t RFCOMM_Channels[RFCOMM_MAX_OPEN_CHANNELS];
 103
 104         /* Function Prototypes: */
 105                 void              RFCOMM_Initialize(void);
 106                 void              RFCOMM_ProcessPacket(void* Data, Bluetooth_Channel_t* const Channel);
 107
 108                 RFCOMM_Channel_t* RFCOMM_GetChannelData(const uint8_t DLCI);
 109                 uint16_t          RFCOMM_GetVariableFieldValue(const uint8_t** BufferPos);
 110                 void              RFCOMM_SendFrame(const uint8_t DLCI, const bool CommandResponse, const uint8_t Control,
 111                                                        const uint16_t DataLen, const void* Data, Bluetooth_Channel_t* const Channel);
 112
 113                 #if defined(INCLUDE_FROM_RFCOMM_C)
 114                         static uint8_t RFCOMM_GetFCSValue(const void* FrameStart, uint8_t Length);
 115
 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                 #endif
 123
 124 #endif