mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/qspi_api.h@188:bcfe06ba3d64, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:46:34 2018 +0000
Revision:
188:bcfe06ba3d64
Child:
189:f392fc9709a3
mbed-dev library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 188:bcfe06ba3d64 1
AnnaBridge 188:bcfe06ba3d64 2 /** \addtogroup hal */
AnnaBridge 188:bcfe06ba3d64 3 /** @{*/
AnnaBridge 188:bcfe06ba3d64 4 /* mbed Microcontroller Library
AnnaBridge 188:bcfe06ba3d64 5 * Copyright (c) 2017 ARM Limited
AnnaBridge 188:bcfe06ba3d64 6 *
AnnaBridge 188:bcfe06ba3d64 7 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 188:bcfe06ba3d64 8 * you may not use this file except in compliance with the License.
AnnaBridge 188:bcfe06ba3d64 9 * You may obtain a copy of the License at
AnnaBridge 188:bcfe06ba3d64 10 *
AnnaBridge 188:bcfe06ba3d64 11 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 188:bcfe06ba3d64 12 *
AnnaBridge 188:bcfe06ba3d64 13 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 188:bcfe06ba3d64 14 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 188:bcfe06ba3d64 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 188:bcfe06ba3d64 16 * See the License for the specific language governing permissions and
AnnaBridge 188:bcfe06ba3d64 17 * limitations under the License.
AnnaBridge 188:bcfe06ba3d64 18 */
AnnaBridge 188:bcfe06ba3d64 19 #ifndef MBED_QSPI_API_H
AnnaBridge 188:bcfe06ba3d64 20 #define MBED_QSPI_API_H
AnnaBridge 188:bcfe06ba3d64 21
AnnaBridge 188:bcfe06ba3d64 22 #include "device.h"
AnnaBridge 188:bcfe06ba3d64 23 #include <stdbool.h>
AnnaBridge 188:bcfe06ba3d64 24
AnnaBridge 188:bcfe06ba3d64 25 #if DEVICE_QSPI
AnnaBridge 188:bcfe06ba3d64 26
AnnaBridge 188:bcfe06ba3d64 27 #ifdef __cplusplus
AnnaBridge 188:bcfe06ba3d64 28 extern "C" {
AnnaBridge 188:bcfe06ba3d64 29 #endif
AnnaBridge 188:bcfe06ba3d64 30
AnnaBridge 188:bcfe06ba3d64 31 /**
AnnaBridge 188:bcfe06ba3d64 32 * \defgroup hal_qspi QSPI HAL
AnnaBridge 188:bcfe06ba3d64 33 * @{
AnnaBridge 188:bcfe06ba3d64 34 */
AnnaBridge 188:bcfe06ba3d64 35
AnnaBridge 188:bcfe06ba3d64 36 /** QSPI HAL object
AnnaBridge 188:bcfe06ba3d64 37 */
AnnaBridge 188:bcfe06ba3d64 38 typedef struct qspi_s qspi_t;
AnnaBridge 188:bcfe06ba3d64 39
AnnaBridge 188:bcfe06ba3d64 40 /** QSPI Bus width
AnnaBridge 188:bcfe06ba3d64 41 *
AnnaBridge 188:bcfe06ba3d64 42 * Some parts of commands provide variable bus width
AnnaBridge 188:bcfe06ba3d64 43 */
AnnaBridge 188:bcfe06ba3d64 44 typedef enum qspi_bus_width {
AnnaBridge 188:bcfe06ba3d64 45 QSPI_CFG_BUS_SINGLE,
AnnaBridge 188:bcfe06ba3d64 46 QSPI_CFG_BUS_DUAL,
AnnaBridge 188:bcfe06ba3d64 47 QSPI_CFG_BUS_QUAD,
AnnaBridge 188:bcfe06ba3d64 48 } qspi_bus_width_t;
AnnaBridge 188:bcfe06ba3d64 49
AnnaBridge 188:bcfe06ba3d64 50 /** Address size in bits
AnnaBridge 188:bcfe06ba3d64 51 */
AnnaBridge 188:bcfe06ba3d64 52 typedef enum qspi_address_size {
AnnaBridge 188:bcfe06ba3d64 53 QSPI_CFG_ADDR_SIZE_8,
AnnaBridge 188:bcfe06ba3d64 54 QSPI_CFG_ADDR_SIZE_16,
AnnaBridge 188:bcfe06ba3d64 55 QSPI_CFG_ADDR_SIZE_24,
AnnaBridge 188:bcfe06ba3d64 56 QSPI_CFG_ADDR_SIZE_32,
AnnaBridge 188:bcfe06ba3d64 57 } qspi_address_size_t;
AnnaBridge 188:bcfe06ba3d64 58
AnnaBridge 188:bcfe06ba3d64 59 /** Alternative size in bits
AnnaBridge 188:bcfe06ba3d64 60 */
AnnaBridge 188:bcfe06ba3d64 61 typedef enum qspi_alt_size {
AnnaBridge 188:bcfe06ba3d64 62 QSPI_CFG_ALT_SIZE_8,
AnnaBridge 188:bcfe06ba3d64 63 QSPI_CFG_ALT_SIZE_16,
AnnaBridge 188:bcfe06ba3d64 64 QSPI_CFG_ALT_SIZE_24,
AnnaBridge 188:bcfe06ba3d64 65 QSPI_CFG_ALT_SIZE_32,
AnnaBridge 188:bcfe06ba3d64 66 } qspi_alt_size_t;
AnnaBridge 188:bcfe06ba3d64 67
AnnaBridge 188:bcfe06ba3d64 68 /** QSPI command
AnnaBridge 188:bcfe06ba3d64 69 *
AnnaBridge 188:bcfe06ba3d64 70 * Defines a frame format. It consists of instruction, address, alternative, dummy count and data
AnnaBridge 188:bcfe06ba3d64 71 */
AnnaBridge 188:bcfe06ba3d64 72 typedef struct qspi_command {
AnnaBridge 188:bcfe06ba3d64 73 struct {
AnnaBridge 188:bcfe06ba3d64 74 qspi_bus_width_t bus_width; /**< Bus width for the instruction >*/
AnnaBridge 188:bcfe06ba3d64 75 uint8_t value; /**< Instruction value >*/
AnnaBridge 188:bcfe06ba3d64 76 bool disabled; /**< Instruction phase skipped if disabled is set to true >*/
AnnaBridge 188:bcfe06ba3d64 77 } instruction;
AnnaBridge 188:bcfe06ba3d64 78 struct {
AnnaBridge 188:bcfe06ba3d64 79 qspi_bus_width_t bus_width; /**< Bus width for the address >*/
AnnaBridge 188:bcfe06ba3d64 80 qspi_address_size_t size; /**< Address size >*/
AnnaBridge 188:bcfe06ba3d64 81 uint32_t value; /**< Address value >*/
AnnaBridge 188:bcfe06ba3d64 82 bool disabled; /**< Address phase skipped if disabled is set to true >*/
AnnaBridge 188:bcfe06ba3d64 83 } address;
AnnaBridge 188:bcfe06ba3d64 84 struct {
AnnaBridge 188:bcfe06ba3d64 85 qspi_bus_width_t bus_width; /**< Bus width for alternative >*/
AnnaBridge 188:bcfe06ba3d64 86 qspi_alt_size_t size; /**< Alternative size >*/
AnnaBridge 188:bcfe06ba3d64 87 uint32_t value; /**< Alternative value >*/
AnnaBridge 188:bcfe06ba3d64 88 bool disabled; /**< Alternative phase skipped if disabled is set to true >*/
AnnaBridge 188:bcfe06ba3d64 89 } alt;
AnnaBridge 188:bcfe06ba3d64 90 uint8_t dummy_count; /**< Dummy cycles count >*/
AnnaBridge 188:bcfe06ba3d64 91 struct {
AnnaBridge 188:bcfe06ba3d64 92 qspi_bus_width_t bus_width; /**< Bus width for data >*/
AnnaBridge 188:bcfe06ba3d64 93 } data;
AnnaBridge 188:bcfe06ba3d64 94 } qspi_command_t;
AnnaBridge 188:bcfe06ba3d64 95
AnnaBridge 188:bcfe06ba3d64 96 /** QSPI return status
AnnaBridge 188:bcfe06ba3d64 97 */
AnnaBridge 188:bcfe06ba3d64 98 typedef enum qspi_status {
AnnaBridge 188:bcfe06ba3d64 99 QSPI_STATUS_ERROR = -1, /**< Generic error >*/
AnnaBridge 188:bcfe06ba3d64 100 QSPI_STATUS_INVALID_PARAMETER = -2, /**< The parameter is invalid >*/
AnnaBridge 188:bcfe06ba3d64 101 QSPI_STATUS_OK = 0, /**< Function executed sucessfully >*/
AnnaBridge 188:bcfe06ba3d64 102 } qspi_status_t;
AnnaBridge 188:bcfe06ba3d64 103
AnnaBridge 188:bcfe06ba3d64 104 /** Initialize QSPI peripheral.
AnnaBridge 188:bcfe06ba3d64 105 *
AnnaBridge 188:bcfe06ba3d64 106 * It should initialize QSPI pins (io0-io3, sclk and ssel), set frequency, clock polarity and phase mode. The clock for the peripheral should be enabled
AnnaBridge 188:bcfe06ba3d64 107 *
AnnaBridge 188:bcfe06ba3d64 108 * @param obj QSPI object
AnnaBridge 188:bcfe06ba3d64 109 * @param io0 Data pin 0
AnnaBridge 188:bcfe06ba3d64 110 * @param io1 Data pin 1
AnnaBridge 188:bcfe06ba3d64 111 * @param io2 Data pin 2
AnnaBridge 188:bcfe06ba3d64 112 * @param io3 Data pin 3
AnnaBridge 188:bcfe06ba3d64 113 * @param sclk The clock pin
AnnaBridge 188:bcfe06ba3d64 114 * @param ssel The chip select pin
AnnaBridge 188:bcfe06ba3d64 115 * @param hz The bus frequency
AnnaBridge 188:bcfe06ba3d64 116 * @param mode Clock polarity and phase mode (0 - 3)
AnnaBridge 188:bcfe06ba3d64 117 * @return QSPI_STATUS_OK if initialisation successfully executed
AnnaBridge 188:bcfe06ba3d64 118 QSPI_STATUS_INVALID_PARAMETER if invalid parameter found
AnnaBridge 188:bcfe06ba3d64 119 QSPI_STATUS_ERROR otherwise
AnnaBridge 188:bcfe06ba3d64 120 */
AnnaBridge 188:bcfe06ba3d64 121 qspi_status_t qspi_init(qspi_t *obj, PinName io0, PinName io1, PinName io2, PinName io3, PinName sclk, PinName ssel, uint32_t hz, uint8_t mode);
AnnaBridge 188:bcfe06ba3d64 122
AnnaBridge 188:bcfe06ba3d64 123 /** Deinitilize QSPI peripheral
AnnaBridge 188:bcfe06ba3d64 124 *
AnnaBridge 188:bcfe06ba3d64 125 * It should release pins that are associated with the QSPI object, and disable clocks for QSPI peripheral module that was associated with the object
AnnaBridge 188:bcfe06ba3d64 126 *
AnnaBridge 188:bcfe06ba3d64 127 * @param obj QSPI object
AnnaBridge 188:bcfe06ba3d64 128 * @return QSPI_STATUS_OK if deinitialisation successfully executed
AnnaBridge 188:bcfe06ba3d64 129 QSPI_STATUS_INVALID_PARAMETER if invalid parameter found
AnnaBridge 188:bcfe06ba3d64 130 QSPI_STATUS_ERROR otherwise
AnnaBridge 188:bcfe06ba3d64 131 */
AnnaBridge 188:bcfe06ba3d64 132 qspi_status_t qspi_free(qspi_t *obj);
AnnaBridge 188:bcfe06ba3d64 133
AnnaBridge 188:bcfe06ba3d64 134 /** Set the QSPI baud rate
AnnaBridge 188:bcfe06ba3d64 135 *
AnnaBridge 188:bcfe06ba3d64 136 * Actual frequency may differ from the desired frequency due to available dividers and the bus clock
AnnaBridge 188:bcfe06ba3d64 137 * Configures the QSPI peripheral's baud rate
AnnaBridge 188:bcfe06ba3d64 138 * @param obj The SPI object to configure
AnnaBridge 188:bcfe06ba3d64 139 * @param hz The baud rate in Hz
AnnaBridge 188:bcfe06ba3d64 140 * @return QSPI_STATUS_OK if frequency was set
AnnaBridge 188:bcfe06ba3d64 141 QSPI_STATUS_INVALID_PARAMETER if invalid parameter found
AnnaBridge 188:bcfe06ba3d64 142 QSPI_STATUS_ERROR otherwise
AnnaBridge 188:bcfe06ba3d64 143 */
AnnaBridge 188:bcfe06ba3d64 144 qspi_status_t qspi_frequency(qspi_t *obj, int hz);
AnnaBridge 188:bcfe06ba3d64 145
AnnaBridge 188:bcfe06ba3d64 146 /** Send a command and block of data
AnnaBridge 188:bcfe06ba3d64 147 *
AnnaBridge 188:bcfe06ba3d64 148 * @param obj QSPI object
AnnaBridge 188:bcfe06ba3d64 149 * @param command QSPI command
AnnaBridge 188:bcfe06ba3d64 150 * @param data TX buffer
AnnaBridge 188:bcfe06ba3d64 151 * @param[in,out] length in - TX buffer length in bytes, out - number of bytes written
AnnaBridge 188:bcfe06ba3d64 152 * @return QSPI_STATUS_OK if the data has been succesfully sent
AnnaBridge 188:bcfe06ba3d64 153 QSPI_STATUS_INVALID_PARAMETER if invalid parameter found
AnnaBridge 188:bcfe06ba3d64 154 QSPI_STATUS_ERROR otherwise
AnnaBridge 188:bcfe06ba3d64 155 */
AnnaBridge 188:bcfe06ba3d64 156 qspi_status_t qspi_write(qspi_t *obj, const qspi_command_t *command, const void *data, size_t *length);
AnnaBridge 188:bcfe06ba3d64 157
AnnaBridge 188:bcfe06ba3d64 158 /** Send a command (and optionally data) and get the response. Can be used to send/receive device specific commands
AnnaBridge 188:bcfe06ba3d64 159 *
AnnaBridge 188:bcfe06ba3d64 160 * @param obj QSPI object
AnnaBridge 188:bcfe06ba3d64 161 * @param command QSPI command
AnnaBridge 188:bcfe06ba3d64 162 * @param tx_data TX buffer
AnnaBridge 188:bcfe06ba3d64 163 * @param tx_size TX buffer length in bytes
AnnaBridge 188:bcfe06ba3d64 164 * @param rx_data RX buffer
AnnaBridge 188:bcfe06ba3d64 165 * @param rx_size RX buffer length in bytes
AnnaBridge 188:bcfe06ba3d64 166 * @return QSPI_STATUS_OK if the data has been succesfully sent
AnnaBridge 188:bcfe06ba3d64 167 QSPI_STATUS_INVALID_PARAMETER if invalid parameter found
AnnaBridge 188:bcfe06ba3d64 168 QSPI_STATUS_ERROR otherwise
AnnaBridge 188:bcfe06ba3d64 169 */
AnnaBridge 188:bcfe06ba3d64 170 qspi_status_t qspi_command_transfer(qspi_t *obj, const qspi_command_t *command, const void *tx_data, size_t tx_size, void *rx_data, size_t rx_size);
AnnaBridge 188:bcfe06ba3d64 171
AnnaBridge 188:bcfe06ba3d64 172 /** Receive a command and block of data
AnnaBridge 188:bcfe06ba3d64 173 *
AnnaBridge 188:bcfe06ba3d64 174 * @param obj QSPI object
AnnaBridge 188:bcfe06ba3d64 175 * @param command QSPI command
AnnaBridge 188:bcfe06ba3d64 176 * @param data RX buffer
AnnaBridge 188:bcfe06ba3d64 177 * @param[in,out] length in - RX buffer length in bytes, out - number of bytes read
AnnaBridge 188:bcfe06ba3d64 178 * @return QSPI_STATUS_OK if data has been succesfully received
AnnaBridge 188:bcfe06ba3d64 179 QSPI_STATUS_INVALID_PARAMETER if invalid parameter found
AnnaBridge 188:bcfe06ba3d64 180 QSPI_STATUS_ERROR otherwise
AnnaBridge 188:bcfe06ba3d64 181 */
AnnaBridge 188:bcfe06ba3d64 182 qspi_status_t qspi_read(qspi_t *obj, const qspi_command_t *command, void *data, size_t *length);
AnnaBridge 188:bcfe06ba3d64 183
AnnaBridge 188:bcfe06ba3d64 184 /**@}*/
AnnaBridge 188:bcfe06ba3d64 185
AnnaBridge 188:bcfe06ba3d64 186 #ifdef __cplusplus
AnnaBridge 188:bcfe06ba3d64 187 }
AnnaBridge 188:bcfe06ba3d64 188 #endif
AnnaBridge 188:bcfe06ba3d64 189
AnnaBridge 188:bcfe06ba3d64 190 #endif
AnnaBridge 188:bcfe06ba3d64 191
AnnaBridge 188:bcfe06ba3d64 192 #endif
AnnaBridge 188:bcfe06ba3d64 193
AnnaBridge 188:bcfe06ba3d64 194 /** @}*/