mlmr.h File Reference

Multi Link Multi Role Service API. More...

#include "gr_includes.h"
#include "custom_config.h"
+ Include dependency graph for mlmr.h:

Go to the source code of this file.

Classes

struct  mlmr_evt_t
 Multi Link Multi Role Service event. More...
 
struct  mlmr_init_t
 Multi Link Multi Role Service init stucture. More...
 

Macros

#define MLMR_CONNECTION_MAX   10
 Maximum number of Multi Link Multi Role Service connections. More...
 
#define MLMR_MAX_DATA_LEN   247
 Maximum length of application data packet which is transmitted via MLMR. More...
 
#define MLMR_FLOW_CTRL_LEN   1
 Maximum length of ble flow control data packet which is transmitted via MLMR. More...
 
#define MLMR_SERVICE_UUID
 The UUID of Multi Link Multi Role Service for setting advertising data. More...
 

Typedefs

typedef uint8_t mlmr_flow_ctrl_state_t
 Underlying type used for the MLMR flow control state. More...
 
typedef void(* mlmr_evt_handler_t) (mlmr_evt_t *p_evt)
 Multi Link Multi Role Service event handler type. More...
 

Enumerations

enum  mlmr_evt_type_t {
  MLMR_EVT_INVALID, MLMR_EVT_RX_DATA_RECEIVED, MLMR_EVT_TX_DATA_SENT, MLMR_EVT_TX_PORT_OPENED,
  MLMR_EVT_TX_PORT_CLOSED, MLMR_EVT_FLOW_CTRL_ENABLE, MLMR_EVT_FLOW_CTRL_DISABLE, MLMR_EVT_TX_FLOW_OFF,
  MLMR_EVT_TX_FLOW_ON
}
 Multi Link Multi Role Service event types. More...
 
enum  mlmr_flow_ctrl_state { MLMR_FLOW_CTRL_STATE_OFF = 0, MLMR_FLOW_CTRL_STATE_ON }
 Flow control state for MLMR service. More...
 

Functions

sdk_err_t mlmr_service_init (mlmr_init_t *p_mlmr_init)
 Initialize a Multi Link Multi Role Service instance and add in the database. More...
 
sdk_err_t mlmr_tx_data_send (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
 Send data to peer device. More...
 
sdk_err_t mlmr_rx_flow_ctrl_set (uint8_t conn_idx, mlmr_flow_ctrl_state_t flow_ctrl)
 Send MLMR Rx flow control state to peer device. More...
 

Detailed Description

Multi Link Multi Role Service API.

Attention
Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file mlmr.h.