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@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
188:bcfe06ba3d64 
mbed library release version 165

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