Toyomasa Watarai / easy-connect-type-yd

Easily add all supported connectivity methods to your mbed OS project

Dependencies:   type-yd-driver

stm-spirit1-rf-driver/source/libs/spirit1/SPIRIT1_Library/Inc/MCU_Interface.h@0:615f90842ce8, 2017-07-12 (annotated)

Committer:
MACRUM
Date:
Wed Jul 12 10:52:58 2017 +0000
Revision:
0:615f90842ce8
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MACRUM 0:615f90842ce8 1 /**
MACRUM 0:615f90842ce8 2 * @file MCU_Interface.h
MACRUM 0:615f90842ce8 3 * @author VMA division - AMS
MACRUM 0:615f90842ce8 4 * @version V2.0.2
MACRUM 0:615f90842ce8 5 * @date Febrary 7, 2015
MACRUM 0:615f90842ce8 6 * @brief Header file for low level SPIRIT SPI driver.
MACRUM 0:615f90842ce8 7 * @details
MACRUM 0:615f90842ce8 8 *
MACRUM 0:615f90842ce8 9 * This header file constitutes an interface to the SPI driver used to
MACRUM 0:615f90842ce8 10 * communicate with Spirit.
MACRUM 0:615f90842ce8 11 * It exports some function prototypes to write/read registers and FIFOs
MACRUM 0:615f90842ce8 12 * and to send command strobes.
MACRUM 0:615f90842ce8 13 * Since the Spirit libraries are totally platform independent, the implementation
MACRUM 0:615f90842ce8 14 * of these functions are not provided here. The user have to implement these functions
MACRUM 0:615f90842ce8 15 * taking care to keep the exported prototypes.
MACRUM 0:615f90842ce8 16 *
MACRUM 0:615f90842ce8 17 * These functions are:
MACRUM 0:615f90842ce8 18 *
MACRUM 0:615f90842ce8 19 * <ul>
MACRUM 0:615f90842ce8 20 * <li>SpiritSpiInit</i>
MACRUM 0:615f90842ce8 21 * <li>SpiritSpiWriteRegisters</i>
MACRUM 0:615f90842ce8 22 * <li>SpiritSpiReadRegisters</i>
MACRUM 0:615f90842ce8 23 * <li>SpiritSpiCommandStrobes</i>
MACRUM 0:615f90842ce8 24 * <li>SpiritSpiWriteLinearFifo</i>
MACRUM 0:615f90842ce8 25 * <li>SpiritSpiReadLinearFifo</i>
MACRUM 0:615f90842ce8 26 * </ul>
MACRUM 0:615f90842ce8 27 *
MACRUM 0:615f90842ce8 28 * @note An example of SPI driver implementation is available in the <i>Sdk_Eval</i> library.
MACRUM 0:615f90842ce8 29 *
MACRUM 0:615f90842ce8 30 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
MACRUM 0:615f90842ce8 31 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
MACRUM 0:615f90842ce8 32 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
MACRUM 0:615f90842ce8 33 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
MACRUM 0:615f90842ce8 34 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
MACRUM 0:615f90842ce8 35 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
MACRUM 0:615f90842ce8 36 *
MACRUM 0:615f90842ce8 37 * THIS SOURCE CODE IS PROTECTED BY A LICENSE.
MACRUM 0:615f90842ce8 38 * FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED
MACRUM 0:615f90842ce8 39 * IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE.
MACRUM 0:615f90842ce8 40 *
MACRUM 0:615f90842ce8 41 * <h2><center>&copy; COPYRIGHT 2015 STMicroelectronics</center></h2>
MACRUM 0:615f90842ce8 42 */
MACRUM 0:615f90842ce8 43
MACRUM 0:615f90842ce8 44
MACRUM 0:615f90842ce8 45 /* Define to prevent recursive inclusion -------------------------------------*/
MACRUM 0:615f90842ce8 46 #ifndef __MCU_INTERFACE_H
MACRUM 0:615f90842ce8 47 #define __MCU_INTERFACE_H
MACRUM 0:615f90842ce8 48
MACRUM 0:615f90842ce8 49
MACRUM 0:615f90842ce8 50 /* Includes ------------------------------------------------------------------*/
MACRUM 0:615f90842ce8 51 #include "SPIRIT_Types.h"
MACRUM 0:615f90842ce8 52
MACRUM 0:615f90842ce8 53
MACRUM 0:615f90842ce8 54 #ifdef __cplusplus
MACRUM 0:615f90842ce8 55 extern "C" {
MACRUM 0:615f90842ce8 56 #endif
MACRUM 0:615f90842ce8 57
MACRUM 0:615f90842ce8 58
MACRUM 0:615f90842ce8 59 /** @addtogroup SPIRIT_Libraries
MACRUM 0:615f90842ce8 60 * @{
MACRUM 0:615f90842ce8 61 */
MACRUM 0:615f90842ce8 62
MACRUM 0:615f90842ce8 63
MACRUM 0:615f90842ce8 64 /** @defgroup SPIRIT_SPI_Driver SPI Driver
MACRUM 0:615f90842ce8 65 * @brief Header file for low level SPIRIT SPI driver.
MACRUM 0:615f90842ce8 66 * @details See the file <i>@ref MCU_Interface.h</i> for more details.
MACRUM 0:615f90842ce8 67 * @{
MACRUM 0:615f90842ce8 68 */
MACRUM 0:615f90842ce8 69
MACRUM 0:615f90842ce8 70
MACRUM 0:615f90842ce8 71
MACRUM 0:615f90842ce8 72 /** @defgroup SPI_Exported_Types SPI Exported Types
MACRUM 0:615f90842ce8 73 * @{
MACRUM 0:615f90842ce8 74 */
MACRUM 0:615f90842ce8 75
MACRUM 0:615f90842ce8 76 /**
MACRUM 0:615f90842ce8 77 * @}
MACRUM 0:615f90842ce8 78 */
MACRUM 0:615f90842ce8 79
MACRUM 0:615f90842ce8 80
MACRUM 0:615f90842ce8 81
MACRUM 0:615f90842ce8 82 /** @defgroup SPI_Exported_Constants SPI Exported Constants
MACRUM 0:615f90842ce8 83 * @{
MACRUM 0:615f90842ce8 84 */
MACRUM 0:615f90842ce8 85
MACRUM 0:615f90842ce8 86 /**
MACRUM 0:615f90842ce8 87 * @}
MACRUM 0:615f90842ce8 88 */
MACRUM 0:615f90842ce8 89
MACRUM 0:615f90842ce8 90
MACRUM 0:615f90842ce8 91
MACRUM 0:615f90842ce8 92 /** @defgroup SPI_Exported_Macros SPI Exported Macros
MACRUM 0:615f90842ce8 93 * @{
MACRUM 0:615f90842ce8 94 */
MACRUM 0:615f90842ce8 95
MACRUM 0:615f90842ce8 96 /**
MACRUM 0:615f90842ce8 97 * @}
MACRUM 0:615f90842ce8 98 */
MACRUM 0:615f90842ce8 99
MACRUM 0:615f90842ce8 100
MACRUM 0:615f90842ce8 101
MACRUM 0:615f90842ce8 102 /** @defgroup SPI_Exported_Functions SPI Exported Functions
MACRUM 0:615f90842ce8 103 * @{
MACRUM 0:615f90842ce8 104 */
MACRUM 0:615f90842ce8 105
MACRUM 0:615f90842ce8 106 typedef SpiritStatus StatusBytes;
MACRUM 0:615f90842ce8 107
MACRUM 0:615f90842ce8 108 void SdkEvalSpiInit(void);
MACRUM 0:615f90842ce8 109 StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
MACRUM 0:615f90842ce8 110 StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
MACRUM 0:615f90842ce8 111 StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode);
MACRUM 0:615f90842ce8 112 StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
MACRUM 0:615f90842ce8 113 StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
MACRUM 0:615f90842ce8 114
MACRUM 0:615f90842ce8 115 void SdkEvalEnterShutdown(void);
MACRUM 0:615f90842ce8 116 void SdkEvalExitShutdown(void);
MACRUM 0:615f90842ce8 117 SpiritFlagStatus SdkEvalCheckShutdown(void);
MACRUM 0:615f90842ce8 118
MACRUM 0:615f90842ce8 119 #define SpiritEnterShutdown SdkEvalEnterShutdown
MACRUM 0:615f90842ce8 120 #define SpiritExitShutdown SdkEvalExitShutdown
MACRUM 0:615f90842ce8 121 #define SpiritCheckShutdown (SpiritFlagStatus)SdkEvalCheckShutdown
MACRUM 0:615f90842ce8 122
MACRUM 0:615f90842ce8 123
MACRUM 0:615f90842ce8 124 #define SpiritSpiInit SdkEvalSpiInit
MACRUM 0:615f90842ce8 125 #define SpiritSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiWriteRegisters(cRegAddress, cNbBytes, pcBuffer)
MACRUM 0:615f90842ce8 126 #define SpiritSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer) SdkEvalSpiReadRegisters(cRegAddress, cNbBytes, pcBuffer)
MACRUM 0:615f90842ce8 127 #define SpiritSpiCommandStrobes(cCommandCode) SdkEvalSpiCommandStrobes(cCommandCode)
MACRUM 0:615f90842ce8 128 #define SpiritSpiWriteLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiWriteFifo(cNbBytes, pcBuffer)
MACRUM 0:615f90842ce8 129 #define SpiritSpiReadLinearFifo(cNbBytes, pcBuffer) SdkEvalSpiReadFifo(cNbBytes, pcBuffer)
MACRUM 0:615f90842ce8 130
MACRUM 0:615f90842ce8 131 /**
MACRUM 0:615f90842ce8 132 * @}
MACRUM 0:615f90842ce8 133 */
MACRUM 0:615f90842ce8 134
MACRUM 0:615f90842ce8 135 /**
MACRUM 0:615f90842ce8 136 * @}
MACRUM 0:615f90842ce8 137 */
MACRUM 0:615f90842ce8 138
MACRUM 0:615f90842ce8 139
MACRUM 0:615f90842ce8 140 /**
MACRUM 0:615f90842ce8 141 * @}
MACRUM 0:615f90842ce8 142 */
MACRUM 0:615f90842ce8 143
MACRUM 0:615f90842ce8 144
MACRUM 0:615f90842ce8 145
MACRUM 0:615f90842ce8 146 #ifdef __cplusplus
MACRUM 0:615f90842ce8 147 }
MACRUM 0:615f90842ce8 148 #endif
MACRUM 0:615f90842ce8 149
MACRUM 0:615f90842ce8 150 #endif
MACRUM 0:615f90842ce8 151
MACRUM 0:615f90842ce8 152 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/