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_MAX32630FTHR/TOOLCHAIN_IAR/spix.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /**
AnnaBridge 171:3a7713b1edbc 2 * @file
AnnaBridge 171:3a7713b1edbc 3 * @brief This is the high level API for the SPI Execute in Place (SPIX)
AnnaBridge 171:3a7713b1edbc 4 * module.
AnnaBridge 171:3a7713b1edbc 5 * @note If using this SPIX with IAR Embedded Workbench for ARM, it is
AnnaBridge 171:3a7713b1edbc 6 * required to define <tt>IAR_SPIX_PRAGMA=1</tt>. This should be
AnnaBridge 171:3a7713b1edbc 7 * done under Project->Options-> C/C++ Compiler->Preprocessor in the
AnnaBridge 171:3a7713b1edbc 8 * Defined Symbols input box. See the IAR documentation for
AnnaBridge 171:3a7713b1edbc 9 * additional information on how to set a preprocessor define in a
AnnaBridge 171:3a7713b1edbc 10 * project.
AnnaBridge 171:3a7713b1edbc 11 */
AnnaBridge 171:3a7713b1edbc 12 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 13 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 171:3a7713b1edbc 14 *
AnnaBridge 171:3a7713b1edbc 15 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 171:3a7713b1edbc 16 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 171:3a7713b1edbc 17 * to deal in the Software without restriction, including without limitation
AnnaBridge 171:3a7713b1edbc 18 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 171:3a7713b1edbc 19 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 171:3a7713b1edbc 20 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 171:3a7713b1edbc 21 *
AnnaBridge 171:3a7713b1edbc 22 * The above copyright notice and this permission notice shall be included
AnnaBridge 171:3a7713b1edbc 23 * in all copies or substantial portions of the Software.
AnnaBridge 171:3a7713b1edbc 24 *
AnnaBridge 171:3a7713b1edbc 25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 171:3a7713b1edbc 26 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 171:3a7713b1edbc 27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 171:3a7713b1edbc 28 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 171:3a7713b1edbc 29 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 171:3a7713b1edbc 30 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 171:3a7713b1edbc 31 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 171:3a7713b1edbc 32 *
AnnaBridge 171:3a7713b1edbc 33 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 171:3a7713b1edbc 34 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 171:3a7713b1edbc 35 * Products, Inc. Branding Policy.
AnnaBridge 171:3a7713b1edbc 36 *
AnnaBridge 171:3a7713b1edbc 37 * The mere transfer of this software does not imply any licenses
AnnaBridge 171:3a7713b1edbc 38 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 171:3a7713b1edbc 39 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 171:3a7713b1edbc 40 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 171:3a7713b1edbc 41 * ownership rights.
AnnaBridge 171:3a7713b1edbc 42 *
AnnaBridge 171:3a7713b1edbc 43 * $Date: 2016-10-10 19:45:55 -0500 (Mon, 10 Oct 2016) $
AnnaBridge 171:3a7713b1edbc 44 * $Revision: 24674 $
AnnaBridge 171:3a7713b1edbc 45 *
AnnaBridge 171:3a7713b1edbc 46 **************************************************************************** */
AnnaBridge 171:3a7713b1edbc 47
AnnaBridge 171:3a7713b1edbc 48
AnnaBridge 171:3a7713b1edbc 49
AnnaBridge 171:3a7713b1edbc 50 #include "mxc_sys.h"
AnnaBridge 171:3a7713b1edbc 51 #include "spix_regs.h"
AnnaBridge 171:3a7713b1edbc 52
AnnaBridge 171:3a7713b1edbc 53 /* Define to prevent redundant inclusion */
AnnaBridge 171:3a7713b1edbc 54 #ifndef _SPIX_H_
AnnaBridge 171:3a7713b1edbc 55 #define _SPIX_H_
AnnaBridge 171:3a7713b1edbc 56
AnnaBridge 171:3a7713b1edbc 57 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 58 extern "C" {
AnnaBridge 171:3a7713b1edbc 59 #endif
AnnaBridge 171:3a7713b1edbc 60
AnnaBridge 171:3a7713b1edbc 61 /**
AnnaBridge 171:3a7713b1edbc 62 * @ingroup periphlibs
AnnaBridge 171:3a7713b1edbc 63 * @defgroup spix SPIX
AnnaBridge 171:3a7713b1edbc 64 * @brief SPI Execute In Place.
AnnaBridge 171:3a7713b1edbc 65 * @{
AnnaBridge 171:3a7713b1edbc 66 */
AnnaBridge 171:3a7713b1edbc 67
AnnaBridge 171:3a7713b1edbc 68 /* **** Definitions **** */
AnnaBridge 171:3a7713b1edbc 69 /// @brief Options for number of I/O pins to use during for each fetch stage
AnnaBridge 171:3a7713b1edbc 70 typedef enum {
AnnaBridge 171:3a7713b1edbc 71 SPIX_SINGLE_IO = MXC_V_SPIX_FETCH_CTRL_CMD_WIDTH_SINGLE,
AnnaBridge 171:3a7713b1edbc 72 SPIX_DUAL_IO = MXC_V_SPIX_FETCH_CTRL_CMD_WIDTH_DUAL_IO,
AnnaBridge 171:3a7713b1edbc 73 SPIX_QUAD_IO = MXC_V_SPIX_FETCH_CTRL_CMD_WIDTH_QUAD_IO
AnnaBridge 171:3a7713b1edbc 74 } spix_width_t;
AnnaBridge 171:3a7713b1edbc 75
AnnaBridge 171:3a7713b1edbc 76 /// @brief Options for number of address bytes to use during fetch
AnnaBridge 171:3a7713b1edbc 77 typedef enum {
AnnaBridge 171:3a7713b1edbc 78 SPIX_3BYTE_FETCH_ADDR = 0,
AnnaBridge 171:3a7713b1edbc 79 SPIX_4BYTE_FETCH_ADDR = 1
AnnaBridge 171:3a7713b1edbc 80 } spix_addr_size_t;
AnnaBridge 171:3a7713b1edbc 81
AnnaBridge 171:3a7713b1edbc 82 /// @brief SPIX fetch configuration.
AnnaBridge 171:3a7713b1edbc 83 typedef struct {
AnnaBridge 171:3a7713b1edbc 84 spix_width_t cmd_width; ///< Number of I/O lines used for command SPI transaction.
AnnaBridge 171:3a7713b1edbc 85 spix_width_t addr_width; ///< Number of I/O lines used for address SPI transaction.
AnnaBridge 171:3a7713b1edbc 86 spix_width_t data_width; ///< Number of I/O lines used for data SPI transaction.
AnnaBridge 171:3a7713b1edbc 87 spix_addr_size_t addr_size; ///< Use 3 or 4 byte addresses for fetches.
AnnaBridge 171:3a7713b1edbc 88 uint8_t cmd; ///< Command value to initiate fetch.
AnnaBridge 171:3a7713b1edbc 89 uint8_t mode_clocks; ///< Number of SPI clocks required during mode phase of fetch.
AnnaBridge 171:3a7713b1edbc 90 uint8_t no_cmd_mode; ///< Read command sent only once.
AnnaBridge 171:3a7713b1edbc 91 uint16_t mode_data; ///< Data sent with mode clocks.
AnnaBridge 171:3a7713b1edbc 92 } spix_fetch_t;
AnnaBridge 171:3a7713b1edbc 93
AnnaBridge 171:3a7713b1edbc 94 /* **** Globals **** */
AnnaBridge 171:3a7713b1edbc 95
AnnaBridge 171:3a7713b1edbc 96 /* **** Function Prototypes **** */
AnnaBridge 171:3a7713b1edbc 97
AnnaBridge 171:3a7713b1edbc 98 /**
AnnaBridge 171:3a7713b1edbc 99 * @brief Configure SPI execute in place clocking.
AnnaBridge 171:3a7713b1edbc 100 * @param sys_cfg Pointer to system level configuration structure.
AnnaBridge 171:3a7713b1edbc 101 * @param baud Frequency in hertz to set the clock to. May not be able
AnnaBridge 171:3a7713b1edbc 102 * to achieve with the given clock divider.
AnnaBridge 171:3a7713b1edbc 103 * @param sample Number of SPIX clocks to delay the sampling of the SDIO
AnnaBridge 171:3a7713b1edbc 104 * lines. Will use feedback mode if set to 0.
AnnaBridge 171:3a7713b1edbc 105 * @return #E_NO_ERROR if everything is successful
AnnaBridge 171:3a7713b1edbc 106 */
AnnaBridge 171:3a7713b1edbc 107 int SPIX_ConfigClock(const sys_cfg_spix_t *sys_cfg, uint32_t baud, uint8_t sample);
AnnaBridge 171:3a7713b1edbc 108
AnnaBridge 171:3a7713b1edbc 109 /**
AnnaBridge 171:3a7713b1edbc 110 * @brief Configure SPI execute in place slave select.
AnnaBridge 171:3a7713b1edbc 111 * @param ssel Index of which slave select line to use.
AnnaBridge 171:3a7713b1edbc 112 * @param pol Polarity of slave select (0 for active low, 1 for
AnnaBridge 171:3a7713b1edbc 113 * active high).
AnnaBridge 171:3a7713b1edbc 114 * @param act_delay SPIX clocks between slave select assert and active
AnnaBridge 171:3a7713b1edbc 115 * SPI clock.
AnnaBridge 171:3a7713b1edbc 116 * @param inact_delay SPIX clocks between active SPI clock and slave
AnnaBridge 171:3a7713b1edbc 117 * select deassert.
AnnaBridge 171:3a7713b1edbc 118 */
AnnaBridge 171:3a7713b1edbc 119 void SPIX_ConfigSlave(uint8_t ssel, uint8_t pol, uint8_t act_delay, uint8_t inact_delay);
AnnaBridge 171:3a7713b1edbc 120
AnnaBridge 171:3a7713b1edbc 121 /**
AnnaBridge 171:3a7713b1edbc 122 * @brief Configure how the SPIX fetches data.
AnnaBridge 171:3a7713b1edbc 123 * @param fetch Pointer to configuration struct that describes how to
AnnaBridge 171:3a7713b1edbc 124 * fetch data.
AnnaBridge 171:3a7713b1edbc 125 */
AnnaBridge 171:3a7713b1edbc 126 void SPIX_ConfigFetch(const spix_fetch_t *fetch);
AnnaBridge 171:3a7713b1edbc 127
AnnaBridge 171:3a7713b1edbc 128 /**
AnnaBridge 171:3a7713b1edbc 129 * @brief Shutdown SPIX module.
AnnaBridge 171:3a7713b1edbc 130 * @param spix Pointer to SPIX regs.
AnnaBridge 171:3a7713b1edbc 131 * @return #E_NO_ERROR if everything is successful
AnnaBridge 171:3a7713b1edbc 132 */
AnnaBridge 171:3a7713b1edbc 133 int SPIX_Shutdown(mxc_spix_regs_t *spix);
AnnaBridge 171:3a7713b1edbc 134
AnnaBridge 171:3a7713b1edbc 135 /**@} end of group spix */
AnnaBridge 171:3a7713b1edbc 136 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 137 }
AnnaBridge 171:3a7713b1edbc 138 #endif
AnnaBridge 171:3a7713b1edbc 139
AnnaBridge 171:3a7713b1edbc 140 #endif /* _SPIX_H */