ble.h

Go to the documentation of this file.

#ifndef EVE_BLE_H_INCLUDED
#define EVE_BLE_H_INCLUDED

/**********************************************************************/
/* Copyright (c) 2016 Jetro AS.
 * 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. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``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 AUTHOR 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.
 *
 * This file is part of the EVE platform.
 */

 /**
 * \file
 * \brief Header file for BLE subsystem interface.
 *
 * \author DT, Jetro AS
 */ /******************************************************************/

#include <stdbool.h>
#include <core/work.h>
#include <sys/process.h>
#include <sys/event-base.h>
#include <lib/assert.h>
#include <ble_types.h>
#include <ble_advdata.h>
#ifndef __cplusplus
  /* XXX: nrf_svc.h:57:6: error: impossible constraint in 'asm' ...  */
  #include <ble.h>
#endif

/**
 * \addtogroup ble
 * @{
 */

/* TODO: Replace by open interface */

#define BLE_DEVICE_MANAGER_FLASH_RESERVED     (10 * 0x1000)

/** Number of entries in the internal bond database */
#define BLE_BOND_DB_SIZE                      (0x08)

/** Return code, indicates that a current connection is not with a bonded device */
#define BLE_NO_BOND                           (0xFF)

/**
 * EVE service manager init structure.
 *
 * \note The structure is reserved for future use.
 */
typedef struct {
  ble_uuid128_t                     uuid128;                    /**< UUID */
  bool                              multiservice;               /**< TOC defines more than one service */
  bool                              omit_structures;            /**< Do not include structures to services */
  bool                              m2m;                        /**< Machine-to-machine interface */
} eve_svc_init_t;

extern bool eve_svc_push(uint8_t toc_id);
extern bool eve_svc_pull(uint8_t toc_id);
#ifndef __cplusplus
  extern void eve_dm_sys_event_handler(uint32_t evt);
  extern void eve_connection_on_ble_evt(const ble_evt_t *p_ble_evt);
  extern void eve_svc_on_ble_evt(const ble_evt_t *p_ble_evt);
  extern bool eve_disc_on_ble_evt(const ble_evt_t *p_ble_evt);
#endif

/**
 * Function for initializing the EVE service manager.
 *
 * \param[in]   eve_svc_init  Information needed to initialize the service.
 *
 * @return      NRF_SUCCESS on successful initialization of service, otherwise an error code.
 */
uint32_t eve_svc_init(const eve_svc_init_t *eve_svc_init);

/**
 * Set an out-of-band key to be used for the connection.
 */
void BleSetOobAuthKey(const ble_advdata_tk_value_t *AuthKey);

/**
 * Get index of the current connection in an internal bond database
 *
 * \return index in the internal bond database in range of [0...BLE_BOND_DB_SIZE)
           or BLE_NO_BOND if the connected device does not have a bond.
 */
uint8_t BleGetBondId(void);

/**
 * Delete a record from an internal bond database
 *
 * \param[in]   BondId     Index of the record in the database
 */
void BleDeleteBond(uint8_t BondId);

/**
 * Delete all records from an internal bond database
 */
void BleDeleteAllBonds(void);

/**
 * Synchronously wait for completion of pending flash write operations
 */
void BleWaitForFlashOpCompletion(void);

#define BLE_AUTO_LOCK() SWINT_AUTO_LOCK()

#define BLE_PULL(Id) { \
  BLE_AUTO_LOCK(); \
  eve_svc_pull(Id); \
}

#define BLE_PUSH(Id) { \
  BLE_AUTO_LOCK(); \
  eve_svc_push(Id); \
}

#define BLE_SYNC(pt, evt, data) \
  do { \
    BLE_PULL(0xFF); \
    do { \
      PT_YIELD(pt); \
      if (evt == EVENT_BLE_SYNCED) \
        break; \
      if (evt == EVENT_BLE_INITIALIZED \
          || evt == EVENT_BLE_ERROR) \
        goto BleReset_Handler; \
      process_post(PROCESS_CURRENT(), evt, data); \
    } while (1); \
  } while (0)

enum
{
  EVENT_BLE_SYNCED = EVENT_BASE_BLE_START,

  EVENT_BLE__LAST,
};
CTASSERT(EVENT_BLE__LAST <= EVENT_BASE_BLE_END + 1);

PROCESS_NAME(BleProcess);

/** @} */ /* ble */

#endif