nrf_mesh_prov_bearer.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, 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.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR 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.
 */

#ifndef NRF_MESH_PROV_BEARER_H__
#define NRF_MESH_PROV_BEARER_H__

#include <stdint.h>
#include "list.h"

typedef enum
{
 NRF_MESH_PROV_LINK_CLOSE_REASON_SUCCESS = 0, 
 NRF_MESH_PROV_LINK_CLOSE_REASON_TIMEOUT = 1, 
 NRF_MESH_PROV_LINK_CLOSE_REASON_ERROR = 2, 
 NRF_MESH_PROV_LINK_CLOSE_REASON_LAST = NRF_MESH_PROV_LINK_CLOSE_REASON_ERROR 
} nrf_mesh_prov_link_close_reason_t;

typedef struct prov_bearer prov_bearer_t;

typedef uint32_t (*prov_bearer_if_tx_t)(prov_bearer_t * p_bearer, const uint8_t * p_data, uint16_t length);

typedef uint32_t (*prov_bearer_if_listen_start_t)(prov_bearer_t * p_bearer,
 const char * p_uri,
 uint16_t oob_info,
 uint32_t link_timeout_us);

typedef uint32_t (*prov_bearer_if_listen_stop_t)(prov_bearer_t * p_bearer);

typedef uint32_t (*prov_bearer_if_link_open_t)(prov_bearer_t * p_bearer,
 const uint8_t * p_uuid,
 uint32_t link_timeout_us);

typedef void (*prov_bearer_if_link_close_t)(prov_bearer_t * p_bearer,
 nrf_mesh_prov_link_close_reason_t close_reason);

typedef struct
{
 prov_bearer_if_tx_t tx;
 prov_bearer_if_listen_start_t listen_start;
 prov_bearer_if_listen_stop_t listen_stop;
 prov_bearer_if_link_open_t link_open;
 prov_bearer_if_link_close_t link_close;
} prov_bearer_interface_t;

typedef void (*prov_bearer_cb_rx_t)(prov_bearer_t * p_bearer,
 const uint8_t * p_data,
 uint16_t length);

typedef void (*prov_bearer_cb_ack_t)(prov_bearer_t * p_bearer);

typedef void (*prov_bearer_cb_link_opened_t)(prov_bearer_t * p_bearer);

typedef void (*prov_bearer_cb_link_closed_t)(prov_bearer_t * p_bearer,
 nrf_mesh_prov_link_close_reason_t reason);

typedef struct
{
 prov_bearer_cb_rx_t rx;
 prov_bearer_cb_ack_t ack;
 prov_bearer_cb_link_opened_t opened;
 prov_bearer_cb_link_closed_t closed;
} prov_bearer_callbacks_t;

/* @} end of PROV_BEARER_CALLBACKS */

#define NRF_MESH_PROV_BEARER_COUNT (3)

typedef enum
{
 NRF_MESH_PROV_BEARER_ADV = 0x01, 
 NRF_MESH_PROV_BEARER_GATT = 0x02, 
 NRF_MESH_PROV_BEARER_MESH = 0x04 
} nrf_mesh_prov_bearer_type_t;

struct prov_bearer
{
 list_node_t node; 
 nrf_mesh_prov_bearer_type_t bearer_type; 
 const prov_bearer_interface_t * p_interface; 
 const prov_bearer_callbacks_t * p_callbacks; 
 void * p_parent; 
};

#endif