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.

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