circuitpython/supervisor/shared/external_flash/spi_flash.c

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

168 lines
6.5 KiB
C
Raw Normal View History

/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2016, 2017 Scott Shawcroft for Adafruit Industries
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#include "supervisor/spi_flash_api.h"
#include <stdint.h>
#include <string.h>
#include "shared-bindings/busio/SPI.h"
#include "shared-bindings/digitalio/DigitalInOut.h"
#include "shared-bindings/microcontroller/Pin.h"
#include "supervisor/shared/external_flash/common_commands.h"
#include "supervisor/shared/external_flash/external_flash.h"
#include "py/mpconfig.h"
digitalio_digitalinout_obj_t cs_pin;
2020-01-28 17:11:25 -05:00
busio_spi_obj_t supervisor_flash_spi_bus;
2021-03-15 09:57:36 -04:00
const external_flash_device *flash_device;
uint32_t spi_flash_baudrate;
// Enable the flash over SPI.
static bool flash_enable(void) {
if (common_hal_busio_spi_try_lock(&supervisor_flash_spi_bus)) {
common_hal_digitalio_digitalinout_set_value(&cs_pin, false);
return true;
2021-03-15 09:57:36 -04:00
}
return false;
}
// Disable the flash over SPI.
static void flash_disable(void) {
common_hal_digitalio_digitalinout_set_value(&cs_pin, true);
2020-01-28 17:11:25 -05:00
common_hal_busio_spi_unlock(&supervisor_flash_spi_bus);
}
codeformat: Fix filename matching In #4683, tannewt noticed that uncrustify was not running on some file in common-hal. I investigated and found that it was not being run on a bunch of paths. Rather than make incremental changes, I rewrote list_files to work bsaed on regular expressions; these regular expressions are created from the same git-style glob patterns. I spot-checked some specific filenames after this change, and all looks good: ``` $ python3 tools/codeformat.py -v --dry-run tests/basics/int_small.py ports/raspberrypi/common-hal/pulseio/PulseIn.c extmod/virtpin.c tests/thread/thread_exit1.py ports/raspberrypi/background.h extmod/re1.5/recursiveloop.c tools/codeformat.py -v --dry-run tests/basics/int_small.py ports/raspberrypi/common-hal/pulseio/PulseIn.c extmod/virtpin.c tests/thread/thread_exit1.py ports/raspberrypi/background.h extmod/re1.5/recursiveloop.c uncrustify -c /home/jepler/src/circuitpython/tools/uncrustify.cfg -lC --no-backup extmod/virtpin.c ports/raspberrypi/background.h ports/raspberrypi/common-hal/pulseio/PulseIn.c black --fast --line-length=99 -v tests/thread/thread_exit1.py ``` recursiveloop and int_small are excluded, while PulseIn, virtpin, and background are included. Testing running from a subdirectory (not _specifically_ supported though): ``` (cd ports && python3 ../tools/codeformat.py -v --dry-run raspberrypi/common-hal/pulseio/PulseIn.c ../extmod/virtpin.c) ../tools/codeformat.py -v --dry-run raspberrypi/common-hal/pulseio/PulseIn.c ../extmod/virtpin.c uncrustify -c /home/jepler/src/circuitpython/tools/uncrustify.cfg -lC --no-backup ../extmod/virtpin.c raspberrypi/common-hal/pulseio/PulseIn. ``` As a side-effect, a bunch more files are re-formatted now. :-P
2021-04-30 11:47:37 -04:00
static bool transfer(uint8_t *command, uint32_t command_length, uint8_t *data_in, uint8_t *data_out, uint32_t data_length) {
if (!flash_enable()) {
return false;
}
2020-01-28 17:11:25 -05:00
bool status = common_hal_busio_spi_write(&supervisor_flash_spi_bus, command, command_length);
if (status) {
if (data_in != NULL && data_out != NULL) {
2020-01-28 17:11:25 -05:00
status = common_hal_busio_spi_transfer(&supervisor_flash_spi_bus, data_out, data_in, data_length);
} else if (data_out != NULL) {
2020-01-28 17:11:25 -05:00
status = common_hal_busio_spi_read(&supervisor_flash_spi_bus, data_out, data_length, 0xff);
} else if (data_in != NULL) {
2020-01-28 17:11:25 -05:00
status = common_hal_busio_spi_write(&supervisor_flash_spi_bus, data_in, data_length);
}
2018-02-17 03:29:03 -05:00
}
2018-02-16 12:46:34 -05:00
flash_disable();
return status;
2018-02-17 03:29:03 -05:00
}
2021-03-15 09:57:36 -04:00
static bool transfer_command(uint8_t command, uint8_t *data_in, uint8_t *data_out, uint32_t data_length) {
2018-02-17 03:29:03 -05:00
return transfer(&command, 1, data_in, data_out, data_length);
}
bool spi_flash_command(uint8_t command) {
return transfer_command(command, NULL, NULL, 0);
}
2021-03-15 09:57:36 -04:00
bool spi_flash_read_command(uint8_t command, uint8_t *data, uint32_t data_length) {
2018-02-17 03:29:03 -05:00
return transfer_command(command, NULL, data, data_length);
}
2021-03-15 09:57:36 -04:00
bool spi_flash_write_command(uint8_t command, uint8_t *data, uint32_t data_length) {
2018-02-17 03:29:03 -05:00
return transfer_command(command, data, NULL, data_length);
2018-02-16 12:46:34 -05:00
}
// Pack the low 24 bits of the address into a uint8_t array.
2021-03-15 09:57:36 -04:00
static void address_to_bytes(uint32_t address, uint8_t *bytes) {
bytes[0] = (address >> 16) & 0xff;
bytes[1] = (address >> 8) & 0xff;
bytes[2] = address & 0xff;
2018-02-16 12:46:34 -05:00
}
2018-02-17 03:29:03 -05:00
bool spi_flash_sector_command(uint8_t command, uint32_t address) {
uint8_t request[4] = {command, 0x00, 0x00, 0x00};
2018-02-17 03:29:03 -05:00
address_to_bytes(address, request + 1);
return transfer(request, 4, NULL, NULL, 0);
2018-02-16 12:46:34 -05:00
}
2021-03-15 09:57:36 -04:00
bool spi_flash_write_data(uint32_t address, uint8_t *data, uint32_t data_length) {
2018-02-17 03:29:03 -05:00
uint8_t request[4] = {CMD_PAGE_PROGRAM, 0x00, 0x00, 0x00};
common_hal_busio_spi_configure(&supervisor_flash_spi_bus, spi_flash_baudrate, 0, 0, 8);
2018-02-16 12:46:34 -05:00
// Write the SPI flash write address into the bytes following the command byte.
2018-02-17 03:29:03 -05:00
address_to_bytes(address, request + 1);
if (!flash_enable()) {
return false;
}
2020-01-28 17:11:25 -05:00
bool status = common_hal_busio_spi_write(&supervisor_flash_spi_bus, request, 4);
if (status) {
2020-01-28 17:11:25 -05:00
status = common_hal_busio_spi_write(&supervisor_flash_spi_bus, data, data_length);
}
flash_disable();
return status;
2018-02-16 12:46:34 -05:00
}
2021-03-15 09:57:36 -04:00
bool spi_flash_read_data(uint32_t address, uint8_t *data, uint32_t data_length) {
uint8_t request[5] = {CMD_READ_DATA, 0x00, 0x00, 0x00};
uint8_t command_length = 4;
if (flash_device->supports_fast_read) {
request[0] = CMD_FAST_READ_DATA;
command_length = 5;
}
common_hal_busio_spi_configure(&supervisor_flash_spi_bus, spi_flash_baudrate, 0, 0, 8);
// Write the SPI flash read address into the bytes following the command byte.
2018-02-17 03:29:03 -05:00
address_to_bytes(address, request + 1);
if (!flash_enable()) {
return false;
}
2020-01-28 17:11:25 -05:00
bool status = common_hal_busio_spi_write(&supervisor_flash_spi_bus, request, command_length);
if (status) {
2020-01-28 17:11:25 -05:00
status = common_hal_busio_spi_read(&supervisor_flash_spi_bus, data, data_length, 0xff);
}
flash_disable();
return status;
2018-02-16 12:46:34 -05:00
}
void spi_flash_init(void) {
cs_pin.base.type = &digitalio_digitalinout_type;
common_hal_digitalio_digitalinout_construct(&cs_pin, SPI_FLASH_CS_PIN);
// Set CS high (disabled).
common_hal_digitalio_digitalinout_switch_to_output(&cs_pin, true, DRIVE_MODE_PUSH_PULL);
common_hal_digitalio_digitalinout_never_reset(&cs_pin);
2020-01-28 17:11:25 -05:00
supervisor_flash_spi_bus.base.type = &busio_spi_type;
common_hal_busio_spi_construct(&supervisor_flash_spi_bus, SPI_FLASH_SCK_PIN, SPI_FLASH_MOSI_PIN, SPI_FLASH_MISO_PIN, false);
2020-01-28 17:11:25 -05:00
common_hal_busio_spi_never_reset(&supervisor_flash_spi_bus);
common_hal_busio_spi_configure(&supervisor_flash_spi_bus, SPI_FLASH_MAX_BAUDRATE, 0, 0, 8);
return;
2018-02-16 12:46:34 -05:00
}
2021-03-15 09:57:36 -04:00
void spi_flash_init_device(const external_flash_device *device) {
flash_device = device;
spi_flash_baudrate = device->max_clock_speed_mhz * 1000000;
if (spi_flash_baudrate > SPI_FLASH_MAX_BAUDRATE) {
spi_flash_baudrate = SPI_FLASH_MAX_BAUDRATE;
}
common_hal_busio_spi_configure(&supervisor_flash_spi_bus, spi_flash_baudrate, 0, 0, 8);
return;
}