riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

pkg/nordic_softdevice_ble: add missing documentation

Browse Source
This commit is contained in:
Alexandre Abadie 2018-02-28 14:50:58 +01:00
parent 18005666ac
commit a4326620db
2 changed files with 89 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
pkg/nordic_softdevice_ble/doc.txt Normal file
View File

@ -0,0 +1,6 @@
/**
* @defgroup pkg_nordic-softdevice-ble Nordic Softdevice BLE
* @ingroup pkg
* @ingroup net
* @brief Provides a RIOT adaption for Nordic Softdevice BLE library
*/

87
pkg/nordic_softdevice_ble/src/ble-mac.h
View File

@ -1,6 +1,49 @@
/*
* Copyright (c) 2016, Nordic Semiconductor
* 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 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 the Institute 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 INSTITUTE 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 THE INSTITUTE 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.
*
*/
/**
* @ingroup pkg_nordic-softdevice-ble
* @brief Public API and definitions of Nordic Softdevice BLE
* @{
*
* @file
*/
#ifndef BLE_MAC_H
#define BLE_MAC_H
#ifdef __cplusplus
extern "C" {
#endif
typedef enum {
BLE_EVENT_RX_DONE = 20000,
} ble_mac_event_enum_t;
@ -14,6 +57,13 @@ typedef enum {
#include "net/eui64.h"
/**
* @brief Get BLE EUI64 from EUI48
*
* @param[out] eui64 The output EUI64 (8 bytes long)
* @param[in] eui48 The input EUI48 (6 bytes long)
* @param[in] _public True if public interface, false otherwise
*/
static inline void ble_eui64_from_eui48(uint8_t eui64[8], uint8_t eui48[6], int _public)
{
eui64[0] = eui48[5];
@ -32,19 +82,48 @@ static inline void ble_eui64_from_eui48(uint8_t eui64[8], uint8_t eui48[6], int
}
}
/**
* @brief Structure handling a received BLE mac packet
*/
typedef struct {
uint8_t src[8];
uint8_t payload[BLE_SIXLOWPAN_MTU];
uint16_t len;
int8_t rssi;
uint8_t src[8]; /**< Source address of the packet */
uint8_t payload[BLE_SIXLOWPAN_MTU]; /**< Payload of the packet */
uint16_t len; /**< Length of the packet */
int8_t rssi; /**< RSSI of the received packet */
} ble_mac_inbuf_t;
/**
* @brief Mac event callback function definition
*/
typedef void (*ble_mac_callback_t)(ble_mac_event_enum_t event, void*arg);
/**
* @brief Initialize the BLE mac
*
* @param[in] callback The callback function triggered on mac event
*/
void ble_mac_init(ble_mac_callback_t callback);
/**
* @brief Send a BLE message
*
* @param[in] dest The destination address
* @param[in] data The data to send
* @param[in] len The length of the data to send
*
* @return 0 if send is successful
* @return <0 if send failed
*/
int ble_mac_send(uint8_t dest[8], void *data, size_t len);
extern volatile int ble_mac_busy_tx; /**< Flag is set to 1 when the driver
is busy transmitting a packet. */
extern volatile int ble_mac_busy_rx; /**< Flag is set to 1 when there is a
received packet pending. */
#ifdef __cplusplus
}
#endif
#endif /* BLE_MAC_H */
/** @} */