mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_ARM_BEETLE_SOC/TOOLCHAIN_ARM_STD/hci_drv.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 2 /*!
AnnaBridge 171:3a7713b1edbc 3 * \file hci_drv.h
AnnaBridge 171:3a7713b1edbc 4 *
AnnaBridge 171:3a7713b1edbc 5 * \brief HCI driver interface.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * $Date: 2013-01-02 22:19:17 -0800 (Wed, 02 Jan 2013) $
AnnaBridge 171:3a7713b1edbc 8 * $Revision: 405 $
AnnaBridge 171:3a7713b1edbc 9 *
AnnaBridge 171:3a7713b1edbc 10 * Copyright (c) 2012 Wicentric, Inc., all rights reserved.
AnnaBridge 171:3a7713b1edbc 11 * Wicentric confidential and proprietary.
AnnaBridge 171:3a7713b1edbc 12 *
AnnaBridge 171:3a7713b1edbc 13 * IMPORTANT. Your use of this file is governed by a Software License Agreement
AnnaBridge 171:3a7713b1edbc 14 * ("Agreement") that must be accepted in order to download or otherwise receive a
AnnaBridge 171:3a7713b1edbc 15 * copy of this file. You may not use or copy this file for any purpose other than
AnnaBridge 171:3a7713b1edbc 16 * as described in the Agreement. If you do not agree to all of the terms of the
AnnaBridge 171:3a7713b1edbc 17 * Agreement do not use this file and delete all copies in your possession or control;
AnnaBridge 171:3a7713b1edbc 18 * if you do not have a copy of the Agreement, you must contact Wicentric, Inc. prior
AnnaBridge 171:3a7713b1edbc 19 * to any use, copying or further distribution of this software.
AnnaBridge 171:3a7713b1edbc 20 */
AnnaBridge 171:3a7713b1edbc 21 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 22 #ifndef HCI_DRV_H
AnnaBridge 171:3a7713b1edbc 23 #define HCI_DRV_H
AnnaBridge 171:3a7713b1edbc 24
AnnaBridge 171:3a7713b1edbc 25 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 26 extern "C" {
AnnaBridge 171:3a7713b1edbc 27 #endif
AnnaBridge 171:3a7713b1edbc 28
AnnaBridge 171:3a7713b1edbc 29 /**************************************************************************************************
AnnaBridge 171:3a7713b1edbc 30 Function Declarations
AnnaBridge 171:3a7713b1edbc 31 **************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 32
AnnaBridge 171:3a7713b1edbc 33 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 34 /*!
AnnaBridge 171:3a7713b1edbc 35 * \fn hciDrvWrite
AnnaBridge 171:3a7713b1edbc 36 *
AnnaBridge 171:3a7713b1edbc 37 * \brief Write data the driver.
AnnaBridge 171:3a7713b1edbc 38 *
AnnaBridge 171:3a7713b1edbc 39 * \param type HCI packet type
AnnaBridge 171:3a7713b1edbc 40 * \param len Number of bytes to write.
AnnaBridge 171:3a7713b1edbc 41 * \param pData Byte array to write.
AnnaBridge 171:3a7713b1edbc 42 *
AnnaBridge 171:3a7713b1edbc 43 * \return Return actual number of data bytes written.
AnnaBridge 171:3a7713b1edbc 44 *
AnnaBridge 171:3a7713b1edbc 45 * \note The type parameter allows the driver layer to prepend the data with a header on the
AnnaBridge 171:3a7713b1edbc 46 * same write transaction.
AnnaBridge 171:3a7713b1edbc 47 */
AnnaBridge 171:3a7713b1edbc 48 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 49 uint16_t hciDrvWrite(uint8_t type, uint16_t len, uint8_t *pData);
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 52 /*!
AnnaBridge 171:3a7713b1edbc 53 * \fn hciDrvRead
AnnaBridge 171:3a7713b1edbc 54 *
AnnaBridge 171:3a7713b1edbc 55 * \brief Read data bytes from the driver.
AnnaBridge 171:3a7713b1edbc 56 *
AnnaBridge 171:3a7713b1edbc 57 * \param len Number of bytes to read.
AnnaBridge 171:3a7713b1edbc 58 * \param pData Byte array to store data.
AnnaBridge 171:3a7713b1edbc 59 *
AnnaBridge 171:3a7713b1edbc 60 * \return Return actual number of data bytes read.
AnnaBridge 171:3a7713b1edbc 61 */
AnnaBridge 171:3a7713b1edbc 62 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 63 uint16_t hciDrvRead(uint16_t len, uint8_t *pData);
AnnaBridge 171:3a7713b1edbc 64
AnnaBridge 171:3a7713b1edbc 65 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 66 /*!
AnnaBridge 171:3a7713b1edbc 67 * \fn hciDrvReadyToSleep
AnnaBridge 171:3a7713b1edbc 68 *
AnnaBridge 171:3a7713b1edbc 69 * \brief Returns TRUE if driver allows MCU to enter low power sleep mode.
AnnaBridge 171:3a7713b1edbc 70 *
AnnaBridge 171:3a7713b1edbc 71 * \return TRUE if ready to sleep, FALSE otherwise.
AnnaBridge 171:3a7713b1edbc 72 */
AnnaBridge 171:3a7713b1edbc 73 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 74 bool_t hciDrvReadyToSleep(void);
AnnaBridge 171:3a7713b1edbc 75
AnnaBridge 171:3a7713b1edbc 76 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 77 };
AnnaBridge 171:3a7713b1edbc 78 #endif
AnnaBridge 171:3a7713b1edbc 79
AnnaBridge 171:3a7713b1edbc 80 #endif /* HCI_DRV_H */