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_IAR/drv_llcc.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 drv_llcc.h
AnnaBridge 171:3a7713b1edbc 4 *
AnnaBridge 171:3a7713b1edbc 5 * \brief LLCC driver.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * Copyright (c) 2015 ARM, Ltd., all rights reserved.
AnnaBridge 171:3a7713b1edbc 8 * ARM confidential and proprietary.
AnnaBridge 171:3a7713b1edbc 9 *
AnnaBridge 171:3a7713b1edbc 10 * IMPORTANT. Your use of this file is governed by a Software License Agreement
AnnaBridge 171:3a7713b1edbc 11 * ("Agreement") that must be accepted in order to download or otherwise receive a
AnnaBridge 171:3a7713b1edbc 12 * copy of this file. You may not use or copy this file for any purpose other than
AnnaBridge 171:3a7713b1edbc 13 * as described in the Agreement. If you do not agree to all of the terms of the
AnnaBridge 171:3a7713b1edbc 14 * Agreement do not use this file and delete all copies in your possession or control;
AnnaBridge 171:3a7713b1edbc 15 * if you do not have a copy of the Agreement, you must contact ARM, Ltd. prior
AnnaBridge 171:3a7713b1edbc 16 * to any use, copying or further distribution of this software.
AnnaBridge 171:3a7713b1edbc 17 */
AnnaBridge 171:3a7713b1edbc 18 /*************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 19
AnnaBridge 171:3a7713b1edbc 20 #ifndef __DRV_LLCC_H
AnnaBridge 171:3a7713b1edbc 21 #define __DRV_LLCC_H
AnnaBridge 171:3a7713b1edbc 22
AnnaBridge 171:3a7713b1edbc 23 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 24 extern "C" {
AnnaBridge 171:3a7713b1edbc 25 #endif
AnnaBridge 171:3a7713b1edbc 26
AnnaBridge 171:3a7713b1edbc 27 /***************************************************************************************************
AnnaBridge 171:3a7713b1edbc 28 ** INCLUDES
AnnaBridge 171:3a7713b1edbc 29 ***************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 30
AnnaBridge 171:3a7713b1edbc 31 #include "chip.h"
AnnaBridge 171:3a7713b1edbc 32 #include "board.h"
AnnaBridge 171:3a7713b1edbc 33
AnnaBridge 171:3a7713b1edbc 34 /***************************************************************************************************
AnnaBridge 171:3a7713b1edbc 35 ** CONSTANTS
AnnaBridge 171:3a7713b1edbc 36 ***************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 37
AnnaBridge 171:3a7713b1edbc 38 /*--------------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 39 ** ENABLE/DISABLE, ON/OFF DEFINES
AnnaBridge 171:3a7713b1edbc 40 **
AnnaBridge 171:3a7713b1edbc 41 ** DESCRIPTION: For clarity in enable parameters.
AnnaBridge 171:3a7713b1edbc 42 --------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 43
AnnaBridge 171:3a7713b1edbc 44 #ifndef DRV_ENABLE
AnnaBridge 171:3a7713b1edbc 45 #define DRV_ENABLE 1
AnnaBridge 171:3a7713b1edbc 46 #endif
AnnaBridge 171:3a7713b1edbc 47
AnnaBridge 171:3a7713b1edbc 48 #ifndef DRV_DISABLE
AnnaBridge 171:3a7713b1edbc 49 #define DRV_DISABLE 0
AnnaBridge 171:3a7713b1edbc 50 #endif
AnnaBridge 171:3a7713b1edbc 51
AnnaBridge 171:3a7713b1edbc 52 #ifndef DRV_ON
AnnaBridge 171:3a7713b1edbc 53 #define DRV_ON 1
AnnaBridge 171:3a7713b1edbc 54 #endif
AnnaBridge 171:3a7713b1edbc 55
AnnaBridge 171:3a7713b1edbc 56 #ifndef DRV_OFF
AnnaBridge 171:3a7713b1edbc 57 #define DRV_OFF 0
AnnaBridge 171:3a7713b1edbc 58 #endif
AnnaBridge 171:3a7713b1edbc 59
AnnaBridge 171:3a7713b1edbc 60 /***************************************************************************************************
AnnaBridge 171:3a7713b1edbc 61 ** TYPES
AnnaBridge 171:3a7713b1edbc 62 ***************************************************************************************************/
AnnaBridge 171:3a7713b1edbc 63
AnnaBridge 171:3a7713b1edbc 64 typedef void (*DRV_LLCC_WD_CALLBACK_t) (uint8_t type, uint8_t *pData, void *pContext, int32_t error);
AnnaBridge 171:3a7713b1edbc 65 typedef void (*DRV_LLCC_RD_CALLBACK_t) (uint8_t type, uint8_t *pData, uint8_t align, uint16_t len);
AnnaBridge 171:3a7713b1edbc 66 typedef void * (*DRV_LLCC_ALLOC_CALLBACK_t) (uint16_t len);
AnnaBridge 171:3a7713b1edbc 67
AnnaBridge 171:3a7713b1edbc 68 /*--------------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 69 ** struct drv_llcc
AnnaBridge 171:3a7713b1edbc 70 **
AnnaBridge 171:3a7713b1edbc 71 ** DESCRIPTION: Access structure of driver.
AnnaBridge 171:3a7713b1edbc 72 --------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 73
AnnaBridge 171:3a7713b1edbc 74 struct drv_llcc {
AnnaBridge 171:3a7713b1edbc 75 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 76 ** Initialize()
AnnaBridge 171:3a7713b1edbc 77 **
AnnaBridge 171:3a7713b1edbc 78 ** DESCRIPTION: Initialize ESS IPCC interface
AnnaBridge 171:3a7713b1edbc 79 ** RETURNS: 0 or error (if not 0)
AnnaBridge 171:3a7713b1edbc 80 ---------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 81 int32_t (*Initialize)(void);
AnnaBridge 171:3a7713b1edbc 82
AnnaBridge 171:3a7713b1edbc 83 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 84 ** Reset()
AnnaBridge 171:3a7713b1edbc 85 **
AnnaBridge 171:3a7713b1edbc 86 ** DESCRIPTION: Take the ESS IPCC into or out of reset.
AnnaBridge 171:3a7713b1edbc 87 ** PARAMETERS: on If not 0, take the ESS IPCC out of reset
AnnaBridge 171:3a7713b1edbc 88 ---------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 89 void (*Reset)(int32_t on);
AnnaBridge 171:3a7713b1edbc 90
AnnaBridge 171:3a7713b1edbc 91 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 92 ** SetTxHandler()
AnnaBridge 171:3a7713b1edbc 93 **
AnnaBridge 171:3a7713b1edbc 94 ** DESCRIPTION: Set handler for transmit events
AnnaBridge 171:3a7713b1edbc 95 ** PARAMETERS: cb Pointer to callback; if NULL, the default handler is set
AnnaBridge 171:3a7713b1edbc 96 ---------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 97 void (*SetTxHandler)(DRV_LLCC_WD_CALLBACK_t cb);
AnnaBridge 171:3a7713b1edbc 98
AnnaBridge 171:3a7713b1edbc 99 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 100 ** SetRxHandler()
AnnaBridge 171:3a7713b1edbc 101 **
AnnaBridge 171:3a7713b1edbc 102 ** DESCRIPTION: Set handler for receive events
AnnaBridge 171:3a7713b1edbc 103 ** PARAMETERS: cb Pointer to callback; if NULL, the default handler is set
AnnaBridge 171:3a7713b1edbc 104 ---------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 105 void (*SetRxHandler)(DRV_LLCC_RD_CALLBACK_t cb);
AnnaBridge 171:3a7713b1edbc 106
AnnaBridge 171:3a7713b1edbc 107 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 108 ** SetAllocHandler()
AnnaBridge 171:3a7713b1edbc 109 **
AnnaBridge 171:3a7713b1edbc 110 ** DESCRIPTION: Set handler for allocate requests
AnnaBridge 171:3a7713b1edbc 111 ** PARAMETERS: cb Pointer to callback; if NULL, the default handler is set
AnnaBridge 171:3a7713b1edbc 112 ---------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 113 void (*SetAllocHandler)(DRV_LLCC_ALLOC_CALLBACK_t cb);
AnnaBridge 171:3a7713b1edbc 114
AnnaBridge 171:3a7713b1edbc 115 /*----------------------------------------------------------------------------------------------
AnnaBridge 171:3a7713b1edbc 116 ** Write()
AnnaBridge 171:3a7713b1edbc 117 **
AnnaBridge 171:3a7713b1edbc 118 ** DESCRIPTION: Write to write channel
AnnaBridge 171:3a7713b1edbc 119 ** PARAMETERS: cmd Command to send
AnnaBridge 171:3a7713b1edbc 120 ** data Pointer to buffer with data to send
AnnaBridge 171:3a7713b1edbc 121 ** num Number of bytes to write
AnnaBridge 171:3a7713b1edbc 122 ** context Context associated with this write
AnnaBridge 171:3a7713b1edbc 123 ** RETURNS: Number of bytes written or error (if less than 0)
AnnaBridge 171:3a7713b1edbc 124 ---------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 125 int32_t (*Write)(uint32_t cmd, const uint8_t *data, uint16_t num, void *context);
AnnaBridge 171:3a7713b1edbc 126 };
AnnaBridge 171:3a7713b1edbc 127
AnnaBridge 171:3a7713b1edbc 128 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 129 }
AnnaBridge 171:3a7713b1edbc 130 #endif
AnnaBridge 171:3a7713b1edbc 131
AnnaBridge 171:3a7713b1edbc 132 #endif /* __DRV_LLCC_H */