src/main/drivers/bus_octospi.h

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Dominic Clifton
  21  */
  22
  23 #pragma once
  24
  25 #ifdef USE_OCTOSPI
  26
  27 typedef enum OCTOSPIDevice {
  28     OCTOSPIINVALID = -1,
  29     OCTOSPIDEV_1   = 0,
  30 } OCTOSPIDevice;
  31
  32 #define OCTOSPIDEV_COUNT 1
  33
  34 // Macros to convert between configuration ids and device ids.
  35 #define OCTOSPI_CFG_TO_DEV(x)   ((x) - 1)
  36 #define OCTOSPI_DEV_TO_CFG(x)   ((x) + 1)
  37
  38 #if !defined(STM32H7)
  39 #error OctoSPI unsupported on this MCU
  40 #endif
  41
  42 OCTOSPIDevice octoSpiDeviceByInstance(OCTOSPI_TypeDef *instance);
  43 OCTOSPI_TypeDef *octoSpiInstanceByDevice(OCTOSPIDevice device);
  44
  45 bool octoSpiInit(OCTOSPIDevice device);
  46 bool octoSpiReceive1LINE(OCTOSPI_TypeDef *instance, uint8_t instruction, uint8_t dummyCycles, uint8_t *in, int length);
  47 bool octoSpiReceive4LINES(OCTOSPI_TypeDef *instance, uint8_t instruction, uint8_t dummyCycles, uint8_t *in, int length);
  48 bool octoSpiTransmit1LINE(OCTOSPI_TypeDef *instance, uint8_t instruction, uint8_t dummyCycles, const uint8_t *out, int length);
  49
  50 bool octoSpiReceiveWithAddress1LINE(OCTOSPI_TypeDef *instance, uint8_t instruction, uint8_t dummyCycles, uint32_t address, uint8_t addressSize, uint8_t *in, int length);
  51 bool octoSpiReceiveWithAddress4LINES(OCTOSPI_TypeDef *instance, uint8_t instruction, uint8_t dummyCycles, uint32_t address, uint8_t addressSize, uint8_t *in, int length);
  52 bool octoSpiTransmitWithAddress1LINE(OCTOSPI_TypeDef *instance, uint8_t instruction, uint8_t dummyCycles, uint32_t address, uint8_t addressSize, const uint8_t *out, int length);
  53 bool octoSpiTransmitWithAddress4LINES(OCTOSPI_TypeDef *instance, uint8_t instruction, uint8_t dummyCycles, uint32_t address, uint8_t addressSize, const uint8_t *out, int length);
  54
  55 bool octoSpiInstructionWithAddress1LINE(OCTOSPI_TypeDef *instance, uint8_t instruction, uint8_t dummyCycles, uint32_t address, uint8_t addressSize);
  56
  57 void octoSpiDisableMemoryMappedMode(OCTOSPI_TypeDef *instance);
  58 void octoSpiEnableMemoryMappedMode(OCTOSPI_TypeDef *instance);
  59
  60 #endif