/**
* UNPUBLISHED PROPRIETARY SOURCE CODE
* Copyright (c) 2016 MXCHIP Inc.
*
* The contents of this file may not be disclosed to third parties, copied or
* duplicated in any form, in whole or in part, without the prior written
* permission of MXCHIP Corporation.
*
*/
/** @file
*
* Bluetooth RFCOMM Application Programming Interface
*
*/
#pragma once
#include "mico.h"
//#include "mico_bt_dev.h"
/******************************************************
* Constants and Type definitions
******************************************************/
/** RFCOMM Port Event Masks */
typedef enum mico_bt_rfcomm_port_event_e
{
MICO_BT_RFCOMM_EV_RXCHAR = 0x00000001, /**< Any Character received */
MICO_BT_RFCOMM_EV_RXFLAG = 0x00000002, /**< Received certain character */
MICO_BT_RFCOMM_EV_TXEMPTY = 0x00000004, /**< Transmitt Queue Empty */
MICO_BT_RFCOMM_EV_CTS = 0x00000008, /**< CTS changed state */
MICO_BT_RFCOMM_EV_DSR = 0x00000010, /**< DSR changed state */
MICO_BT_RFCOMM_EV_RLSD = 0x00000020, /**< RLSD changed state */
MICO_BT_RFCOMM_EV_BREAK = 0x00000040, /**< BREAK received */
MICO_BT_RFCOMM_EV_ERR = 0x00000080, /**< Line status error occurred */
MICO_BT_RFCOMM_EV_RING = 0x00000100, /**< Ring signal detected */
MICO_BT_RFCOMM_EV_CTSS = 0x00000400, /**< CTS state */
MICO_BT_RFCOMM_EV_DSRS = 0x00000800, /**< DSR state */
MICO_BT_RFCOMM_EV_RLSDS = 0x00001000, /**< RLSD state */
MICO_BT_RFCOMM_EV_OVERRUN = 0x00002000, /**< receiver buffer overrun */
MICO_BT_RFCOMM_EV_TXCHAR = 0x00004000, /**< Any character transmitted */
MICO_BT_RFCOMM_EV_CONNECTED = 0x00000200, /**< RFCOMM connection established */
MICO_BT_RFCOMM_EV_CONNECT_ERR = 0x00008000, /**< Was not able to establish connection or disconnected */
MICO_BT_RFCOMM_EV_FC = 0x00010000, /**< data flow enabled flag changed by remote */
MICO_BT_RFCOMM_EV_FCS = 0x00020000, /**< data flow enable status true = enabled */
} mico_bt_rfcomm_port_event_t;
#define MICO_BT_RFCOMM_MASK_ALL (MICO_BT_RFCOMM_EV_RXCHAR | MICO_BT_RFCOMM_EV_TXEMPTY | MICO_BT_RFCOMM_EV_CTS | \
MICO_BT_RFCOMM_EV_DSR | MICO_BT_RFCOMM_EV_RLSD | MICO_BT_RFCOMM_EV_BREAK | \
MICO_BT_RFCOMM_EV_ERR | MICO_BT_RFCOMM_EV_RING | MICO_BT_RFCOMM_EV_CONNECT_ERR | \
MICO_BT_RFCOMM_EV_DSRS | MICO_BT_RFCOMM_EV_CTSS | MICO_BT_RFCOMM_EV_RLSDS | \
MICO_BT_RFCOMM_EV_RXFLAG | MICO_BT_RFCOMM_EV_TXCHAR | MICO_BT_RFCOMM_EV_OVERRUN | \
MICO_BT_RFCOMM_EV_FC | MICO_BT_RFCOMM_EV_FCS | MICO_BT_RFCOMM_EV_CONNECTED)
/** RFCOMM Result Codes */
enum mico_bt_rfcomm_result_e
{
MICO_BT_RFCOMM_SUCCESS, /**< Success */
MICO_BT_RFCOMM_ERROR, /**< Error */
MICO_BT_RFCOMM_ALREADY_OPENED, /**< Already Opened */
MICO_BT_RFCOMM_CMD_PENDING, /**< Command Pending */
MICO_BT_RFCOMM_APP_NOT_REGISTERED, /**< App Not Registered */
MICO_BT_RFCOMM_NO_MEM, /**< No Memory */
MICO_BT_RFCOMM_NO_RESOURCES, /**< No Resources */
MICO_BT_RFCOMM_BAD_BD_ADDR, /**< Bad BD Address */
MICO_BT_RFCOMM_RESULT_RESERVED0,
MICO_BT_RFCOMM_BAD_HANDLE, /**< Bad Handle */
MICO_BT_RFCOMM_NOT_OPENED, /**< Not Opened */
MICO_BT_RFCOMM_LINE_ERR, /**< Line Error */
MICO_BT_RFCOMM_START_FAILED, /**< Start Failed */
MICO_BT_RFCOMM_PAR_NEG_FAILED,
MICO_BT_RFCOMM_RFCOMM_NEG_FAILED,
MICO_BT_RFCOMM_SEC_FAILED,
MICO_BT_RFCOMM_PEER_CONNECTION_FAILED, /**< Peer Connection Failed */
MICO_BT_RFCOMM_PEER_FAILED, /**< Peer Failed */
MICO_BT_RFCOMM_PEER_TIMEOUT, /**< Peer Timeout */
MICO_BT_RFCOMM_CLOSED, /**< Closed */
MICO_BT_RFCOMM_TX_FULL,
MICO_BT_RFCOMM_LOCAL_CLOSED, /**< Local Closed */
MICO_BT_RFCOMM_LOCAL_TIMEOUT, /**< Local Timeout */
MICO_BT_RFCOMM_TX_QUEUE_DISABLED,
MICO_BT_RFCOMM_PAGE_TIMEOUT, /**< Page Timeout */
MICO_BT_RFCOMM_INVALID_SCN /**< Invalid SCN */
};
typedef int mico_bt_rfcomm_result_t; /**< RFCOMM result code (see #mico_bt_rfcomm_result_e) */
/** RFCOMM Signals */
enum mico_bt_rfcomm_signal_e
{
MICO_BT_RFCOMM_SET_DTRDSR=0x01, /** DTRDSR set */
MICO_BT_RFCOMM_CLR_DTRDSR, /** DTRDSR clear */
MICO_BT_RFCOMM_SET_CTSRTS, /** CTSRTS set */
MICO_BT_RFCOMM_CLR_CTSRTS, /** CTSRTS clear */
MICO_BT_RFCOMM_SET_RI, /** RI set (DCE only) */
MICO_BT_RFCOMM_CLR_RI, /** RI clear (DCE only) */
MICO_BT_RFCOMM_SET_DCD, /** DCD set (DCE only) */
MICO_BT_RFCOMM_CLR_DCD, /** DCD clear (DCE only) */
MICO_BT_RFCOMM_BREAK, /** BRK */
};
typedef uint8_t mico_bt_rfcomm_signal_t; /**< RFCOMM Signals (see #mico_bt_rfcomm_signal_e) */
/**
* Define the callback function prototypes for mico_bt_rfcomm_data_cback_t
*
* @param port_handle : A 16-bit unsigned integer returned by @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink.
* @param *p_data : A pointer to the array of bytes received from the peer device.
* @param len : The length of the data received.
*/
typedef int (mico_bt_rfcomm_data_cback_t) (uint16_t port_handle, void *p_data, uint16_t len);
/**
* Port management callback
*
* @param code : Result code
* @param port_handle : Port handle from @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink.
*/
typedef void (mico_bt_port_mgmt_cback_t) (mico_bt_rfcomm_result_t code, uint16_t port_handle);
/**
* Port event callback
*
* @param event : A 32-bit event code that contains a bit-mask of one or more events the caller would like to register.
* @param port_handle : Port handle from @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink.
*/
typedef void (mico_bt_port_event_cback_t) (mico_bt_rfcomm_port_event_t event, uint16_t port_handle);
/**
* @addtogroup rfcomm_api_functions RFCOMM
* @ingroup micobt
*
* RFCOMM Functions
*
* @{
*/
/******************************************************
* Function Declarations
******************************************************/
#ifdef __cplusplus
extern "C"
{
#endif
/**
* Establish serial port connection to the peer device, or allow
* RFCOMM to accept a connection from peer devices.
*
* @note
* Server can call this function with the same scn parameter multiple times if
* it is ready to accept multiple simulteneous connections.
*
* DLCI for the connection is (scn * 2 + 1) if client originates connection on
* existing none initiator multiplexer channel. Otherwise it is (scn * 2).
* For the server DLCI can be changed later if client will be calling it using
* (scn * 2 + 1) dlci.
*
* @param[in] uuid : The Universal Unique Identifier (UUID) of the
* Class ID of the service being opened
* @param[in] scn : The Service Channel Number(SCN) as registered
* with the SDP (server) or obtained using SDP from
* the peer device (client)
* @param[in] is_server : TRUE if requesting application is a server
* @param[in] mtu : The maximum number of bytes transferred per frame
* If 0, a default size of L2CAP_MTU_SIZE minus
* 5 bytes is used
* @param[in] bd_addr : BD_ADDR of the peer (if client), NULL if server
* @param[in] p_mgmt_cb : Pointer to callback function to receive connection
* up/down events
* @param[out] p_handle : A pointer to the handle set by RFCOMM to be used in
* consecutive calls for this connection
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_ALREADY_OPENED : If the client tries to establish a connection to the same BD_ADDR
* MICO_BT_RFCOMM_NO_RESOURCES : If there is not enough memory to allocate a control block structure
* MICO_BT_RFCOMM_INVALID_SCN : If Server Channel Number(SCN) is out of in range 1...30
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_create_connection (uint16_t uuid, uint8_t scn,
mico_bool_t is_server, uint16_t mtu,
mico_bt_device_address_t bd_addr,
uint16_t *p_handle,
mico_bt_port_mgmt_cback_t *p_mgmt_cb);
/**
* Close the specified connection.
*
* @param[in] handle : The connection handle returned by
* @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink.
* @param[in] remove_server : (for server only) If TRUE, then also remove server; otherwise server remains enabled
* after connection is closed.
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_BAD_HANDLE : If the handle is out of range
* MICO_BT_RFCOMM_NOT_OPENED : If the connection is not opened
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_remove_connection (uint16_t handle, mico_bool_t remove_server);
/**
* Set event callback the specified connection.
*
* @param[in] port_handle : A 16-bit unsigned integer returned by
* @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink
* @param[in] p_port_cb : Address of the callback function which should
* be called from the RFCOMM when an event
* specified in the mask occurs
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_BAD_HANDLE : If the handle is out of range
* MICO_BT_RFCOMM_NOT_OPENED : If the connection is not opened
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_set_event_callback (uint16_t port_handle, mico_bt_port_event_cback_t *p_port_cb);
/**
* Set event data callback the specified connection.
*
* @param[in] port_handle : A 16-bit unsigned integer returned by
* @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink
* @param[in] p_cb : Address of the callback function which should
* be called from the RFCOMM when a data
* packet is received
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_BAD_HANDLE : If the handle is out of range
* MICO_BT_RFCOMM_NOT_OPENED : If the connection is not opened
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_set_data_callback (uint16_t port_handle, mico_bt_rfcomm_data_cback_t *p_cb);
/**
* Set events for which to be notified
*
* @param[in] port_handle : A 16-bit unsigned integer returned by
* @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink
* @param[in] mask : Event mask
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_BAD_HANDLE : If the handle is out of range
* MICO_BT_RFCOMM_NOT_OPENED : If the connection is not opened
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_set_event_mask (uint16_t port_handle, mico_bt_rfcomm_port_event_t mask);
/**
* Send control signal to the peer device.
*
* @param[in] handle : The connection handle returned by
* @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink
* @param[in] signal : Signal to send (see #mico_bt_rfcomm_signal_e)
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_BAD_HANDLE : If the handle is out of range
* MICO_BT_RFCOMM_NOT_OPENED : If the connection is not opened
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_control (uint16_t handle, mico_bt_rfcomm_signal_t signal);
/**
* This function directs a specified connection to pass flow control message to the peer device.
* Enable flag passed shows if port can accept more data.
*
* @param[in] handle : The connection handle returned by
* @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink
* @param[in] enable : Flow control setting
* TRUE Enable data flow
* FALSE Disable data flow
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_BAD_HANDLE : If the handle is out of range
* MICO_BT_RFCOMM_NOT_OPENED : If the connection is not opened
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_flow_control (uint16_t handle, mico_bool_t enable);
/**
* This function directs a specified connection to pass flow control message to the peer device.
* Enable flag passed shows if port can accept more data.
*
* @param[in] handle : The connection handle returned by
* @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink
* @param[in] p_data : Data to write
* @param[in] max_len : Byte count to write
* @param[out] p_len : Bytes written
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_BAD_HANDLE : If the handle is out of range
* MICO_BT_RFCOMM_NOT_OPENED : If the connection is not opened
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_write_data (uint16_t handle, char *p_data, uint16_t max_len, uint16_t *p_len);
/**
* This function checks connection referenced by handle is up and running.
*
* @param[in] handle : The connection handle returned by
* @link mico_bt_rfcomm_create_connection mico_bt_rfcomm_create_connection @endlink
* @param[out] bd_addr : Peer BD Address
* @param[out] p_lcid : L2CAP's LCID
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_LINE_ERR : If connection is not up and running
*/
//mico_bt_rfcomm_result_t mico_bt_rfcomm_check_connection (UINT16 handle, BD_ADDR bd_addr, UINT16 *p_lcid);
#ifdef MPAF_CUSTOM_STACK
/**
* This function allocates private pool to be used by RFCOMM.
*
* @param[in] buffer_size : size of buffer
* @param[out] buffer_cnt : buffers
*
* @return MICO_BT_RFCOMM_SUCCESS : If successful
* MICO_BT_RFCOMM_ERROR : If pool allocation fails
*/
mico_bt_rfcomm_result_t mico_bt_rfcomm_init(uint32_t buffer_size, uint32_t buffer_cnt);
/**
* This function enables flow control based on ACL buffer availability
*
* @param[in] peer_addr : Peer BD Address
*
* @return MICO_TRUE : If successful
* MICO_FALSE : If fails
*/
mico_bool_t mico_bt_rfcomm_control_data_flow(BD_ADDR peer_bda);
#endif
#ifdef __cplusplus
}
#endif
/**@} */