/* * Copyright (c) 2020 Raspberry Pi (Trading) Ltd. * * SPDX-License-Identifier: BSD-3-Clause */ #include #include #include #include "pico/stdlib.h" #include "hardware/gpio.h" #include "hardware/pio.h" #include "hardware/clocks.h" #include "hardware/structs/iobank0.h" #include "hardware/sync.h" #include "hardware/dma.h" #include "cyw43_bus_pio_spi.pio.h" #include "cyw43.h" #include "cyw43_internal.h" #include "cyw43_spi.h" #include "cyw43_debug_pins.h" #if CYW43_SPI_PIO #define WL_REG_ON 23 #define DATA_OUT_PIN 24u #define DATA_IN_PIN 24u #define IRQ_PIN 24u // #define MONITOR_PIN 3u #define CLOCK_PIN 29u #define CS_PIN 25u #define IRQ_SAMPLE_DELAY_NS 100 #define SPI_PROGRAM_NAME spi_gap01_sample0 #define SPI_PROGRAM_FUNC __CONCAT(SPI_PROGRAM_NAME, _program) #define SPI_PROGRAM_GET_DEFAULT_CONFIG_FUNC __CONCAT(SPI_PROGRAM_NAME, _program_get_default_config) #define SPI_OFFSET_END __CONCAT(SPI_PROGRAM_NAME, _offset_end) #define SPI_OFFSET_LP1_END __CONCAT(SPI_PROGRAM_NAME, _offset_lp1_end) #define CLOCK_DIV 2 #define CLOCK_DIV_MINOR 0 #define PADS_DRIVE_STRENGTH PADS_BANK0_GPIO0_DRIVE_VALUE_12MA #if !CYW43_USE_SPI #error CYW43_USE_SPI should be true #endif #ifndef NDEBUG //#define ENABLE_SPI_DUMPING 1 #endif // Set to 1 to enable #if ENABLE_SPI_DUMPING //NDEBUG #if 0 #define DUMP_SPI_TRANSACTIONS(A) A #else static bool enable_spi_packet_dumping; // set to true to dump #define DUMP_SPI_TRANSACTIONS(A) if (enable_spi_packet_dumping) {A} #endif static uint32_t counter = 0; #else #define DUMP_SPI_TRANSACTIONS(A) #endif //#define SWAP32(A) ((((A) & 0xff000000U) >> 8) | (((A) & 0xff0000U) << 8) | (((A) & 0xff00U) >> 8) | (((A) & 0xffU) << 8)) __force_inline static uint32_t __swap16x2(uint32_t a) { __asm ("rev16 %0, %0" : "+l" (a) : : ); return a; } #define SWAP32(a) __swap16x2(a) #ifndef CYW43_SPI_PIO_PREFERRED_PIO #define CYW43_SPI_PIO_PREFERRED_PIO 1 #endif static_assert(CYW43_SPI_PIO_PREFERRED_PIO >=0 && CYW43_SPI_PIO_PREFERRED_PIO < NUM_PIOS, ""); typedef struct { pio_hw_t *pio; uint8_t pio_func_sel; int8_t pio_offset; int8_t pio_sm; int8_t dma_out; int8_t dma_in; } bus_data_t; static bus_data_t bus_data_instance; int cyw43_spi_init(cyw43_int_t *self) { // Only does something if CYW43_LOGIC_DEBUG=1 logic_debug_init(); static_assert(NUM_PIOS == 2, ""); pio_hw_t *pios[2] = {pio0, pio1}; uint pio_index = CYW43_SPI_PIO_PREFERRED_PIO; // Check we can add the program if (!pio_can_add_program(pios[pio_index], &SPI_PROGRAM_FUNC)) { pio_index ^= 1; if (!pio_can_add_program(pios[pio_index], &SPI_PROGRAM_FUNC)) { return CYW43_FAIL_FAST_CHECK(-CYW43_EIO); } } assert(!self->bus_data); self->bus_data = &bus_data_instance; bus_data_t *bus_data = (bus_data_t *)self->bus_data; bus_data->pio = pios[pio_index]; bus_data->dma_in = -1; bus_data->dma_out = -1; static_assert(GPIO_FUNC_PIO1 == GPIO_FUNC_PIO0 + 1, ""); bus_data->pio_func_sel = GPIO_FUNC_PIO0 + pio_index; bus_data->pio_sm = (int8_t)pio_claim_unused_sm(bus_data->pio, false); if (bus_data->pio_sm < 0) { cyw43_spi_deinit(self); return CYW43_FAIL_FAST_CHECK(-CYW43_EIO); } bus_data->pio_offset = pio_add_program(bus_data->pio, &SPI_PROGRAM_FUNC); pio_sm_config config = SPI_PROGRAM_GET_DEFAULT_CONFIG_FUNC(bus_data->pio_offset); sm_config_set_clkdiv_int_frac(&config, CLOCK_DIV, CLOCK_DIV_MINOR); hw_write_masked(&padsbank0_hw->io[CLOCK_PIN], (uint)PADS_DRIVE_STRENGTH << PADS_BANK0_GPIO0_DRIVE_LSB, PADS_BANK0_GPIO0_DRIVE_BITS ); hw_write_masked(&padsbank0_hw->io[CLOCK_PIN], (uint)1 << PADS_BANK0_GPIO0_SLEWFAST_LSB, PADS_BANK0_GPIO0_SLEWFAST_BITS ); sm_config_set_out_pins(&config, DATA_OUT_PIN, 1); sm_config_set_in_pins(&config, DATA_IN_PIN); sm_config_set_set_pins(&config, DATA_OUT_PIN, 1); sm_config_set_sideset(&config, 1, false, false); sm_config_set_sideset_pins(&config, CLOCK_PIN); sm_config_set_in_shift(&config, false, true, 32); sm_config_set_out_shift(&config, false, true, 32); hw_set_bits(&bus_data->pio->input_sync_bypass, 1u << DATA_IN_PIN); pio_sm_set_config(bus_data->pio, bus_data->pio_sm, &config); pio_sm_set_consecutive_pindirs(bus_data->pio, bus_data->pio_sm, CLOCK_PIN, 1, true); gpio_set_function(DATA_OUT_PIN, bus_data->pio_func_sel); gpio_set_function(CLOCK_PIN, bus_data->pio_func_sel); // Set data pin to pull down and schmitt gpio_set_pulls(DATA_IN_PIN, false, true); gpio_set_input_hysteresis_enabled(DATA_IN_PIN, true); pio_sm_exec(bus_data->pio, bus_data->pio_sm, pio_encode_set(pio_pins, 1)); bus_data->dma_out = (int8_t) dma_claim_unused_channel(false); bus_data->dma_in = (int8_t) dma_claim_unused_channel(false); if (bus_data->dma_out < 0 || bus_data->dma_in < 0) { cyw43_spi_deinit(self); return CYW43_FAIL_FAST_CHECK(-CYW43_EIO); } return 0; } void cyw43_spi_deinit(cyw43_int_t *self) { if (self->bus_data) { bus_data_t *bus_data = (bus_data_t *)self->bus_data; if (bus_data->pio_sm >= 0) { if (bus_data->pio_offset != -1) pio_remove_program(bus_data->pio, &SPI_PROGRAM_FUNC, bus_data->pio_offset); pio_sm_unclaim(bus_data->pio, bus_data->pio_sm); } if (bus_data->dma_out >= 0) { dma_channel_unclaim(bus_data->dma_out); bus_data->dma_out = -1; } if (bus_data->dma_in >= 0) { dma_channel_unclaim(bus_data->dma_in); bus_data->dma_in = -1; } self->bus_data = NULL; } } static void cs_set(bool value) { gpio_put(CS_PIN, value); } static __noinline void ns_delay(uint32_t ns) { // cycles = ns * clk_sys_hz / 1,000,000,000 uint32_t cycles = ns * (clock_get_hz(clk_sys) >> 16u) / (1000000000u >> 16u); busy_wait_at_least_cycles(cycles); } static void start_spi_comms(cyw43_int_t *self) { bus_data_t *bus_data = (bus_data_t *)self->bus_data; // Pull CS low cs_set(false); gpio_set_function(DATA_OUT_PIN, bus_data->pio_func_sel); } // we need to atomically de-assert CS and enable IRQ static void stop_spi_comms(void) { // from this point a positive edge will cause an IRQ to be pending cs_set(true); // we need to wait a bit in case the irq line is incorrectly high ns_delay(IRQ_SAMPLE_DELAY_NS); } #if ENABLE_SPI_DUMPING static void dump_bytes(const uint8_t *bptr, uint32_t len) { unsigned int i = 0; for (i = 0; i < len;) { if ((i & 0x0f) == 0) { printf("\n"); } else if ((i & 0x07) == 0) { printf(" "); } printf("%02x ", bptr[i++]); } printf("\n"); } #endif int cyw43_spi_transfer(cyw43_int_t *self, const uint8_t *tx, size_t tx_length, uint8_t *rx, size_t rx_length) { if ((tx == NULL) && (rx == NULL)) { return CYW43_FAIL_FAST_CHECK(-CYW43_EINVAL); } bus_data_t *bus_data = (bus_data_t *)self->bus_data; start_spi_comms(self); if (rx != NULL) { if (tx == NULL) { tx = rx; assert(tx_length && tx_length < rx_length); } DUMP_SPI_TRANSACTIONS( printf("[%lu] bus TX/RX %u bytes rx %u:", counter++, tx_length, rx_length); dump_bytes(tx, tx_length); ) assert(!(tx_length & 3)); assert(!(((uintptr_t)tx) & 3)); assert(!(((uintptr_t)rx) & 3)); assert(!(rx_length & 3)); pio_sm_set_enabled(bus_data->pio, bus_data->pio_sm, false); pio_sm_set_wrap(bus_data->pio, bus_data->pio_sm, bus_data->pio_offset, bus_data->pio_offset + SPI_OFFSET_END - 1); pio_sm_clear_fifos(bus_data->pio, bus_data->pio_sm); pio_sm_set_pindirs_with_mask(bus_data->pio, bus_data->pio_sm, 1u << DATA_OUT_PIN, 1u << DATA_OUT_PIN); pio_sm_restart(bus_data->pio, bus_data->pio_sm); pio_sm_clkdiv_restart(bus_data->pio, bus_data->pio_sm); pio_sm_put(bus_data->pio, bus_data->pio_sm, tx_length * 8 - 1); pio_sm_exec(bus_data->pio, bus_data->pio_sm, pio_encode_out(pio_x, 32)); pio_sm_put(bus_data->pio, bus_data->pio_sm, (rx_length - tx_length) * 8 - 1); pio_sm_exec(bus_data->pio, bus_data->pio_sm, pio_encode_out(pio_y, 32)); pio_sm_exec(bus_data->pio, bus_data->pio_sm, pio_encode_jmp(bus_data->pio_offset)); dma_channel_abort(bus_data->dma_out); dma_channel_abort(bus_data->dma_in); dma_channel_config out_config = dma_channel_get_default_config(bus_data->dma_out); channel_config_set_bswap(&out_config, true); channel_config_set_dreq(&out_config, pio_get_dreq(bus_data->pio, bus_data->pio_sm, true)); dma_channel_configure(bus_data->dma_out, &out_config, &bus_data->pio->txf[0], tx, tx_length / 4, true); dma_channel_config in_config = dma_channel_get_default_config(bus_data->dma_in); channel_config_set_bswap(&in_config, true); channel_config_set_dreq(&in_config, pio_get_dreq(bus_data->pio, bus_data->pio_sm, false)); channel_config_set_write_increment(&in_config, true); channel_config_set_read_increment(&in_config, false); dma_channel_configure(bus_data->dma_in, &in_config, rx + tx_length, &bus_data->pio->rxf[0], rx_length / 4 - tx_length / 4, true); pio_sm_set_enabled(bus_data->pio, bus_data->pio_sm, true); __compiler_memory_barrier(); dma_channel_wait_for_finish_blocking(bus_data->dma_out); dma_channel_wait_for_finish_blocking(bus_data->dma_in); __compiler_memory_barrier(); memset(rx, 0, tx_length); // make sure we don't have garbage in what would have been returned data if using real SPI } else if (tx != NULL) { DUMP_SPI_TRANSACTIONS( printf("[%lu] bus TX only %u bytes:", counter++, tx_length); dump_bytes(tx, tx_length); ) assert(!(((uintptr_t)tx) & 3)); assert(!(tx_length & 3)); pio_sm_set_enabled(bus_data->pio, bus_data->pio_sm, false); pio_sm_set_wrap(bus_data->pio, bus_data->pio_sm, bus_data->pio_offset, bus_data->pio_offset + SPI_OFFSET_LP1_END - 1); pio_sm_clear_fifos(bus_data->pio, bus_data->pio_sm); pio_sm_set_pindirs_with_mask(bus_data->pio, bus_data->pio_sm, 1u << DATA_OUT_PIN, 1u << DATA_OUT_PIN); pio_sm_restart(bus_data->pio, bus_data->pio_sm); pio_sm_clkdiv_restart(bus_data->pio, bus_data->pio_sm); pio_sm_put(bus_data->pio, bus_data->pio_sm, tx_length * 8 - 1); pio_sm_exec(bus_data->pio, bus_data->pio_sm, pio_encode_out(pio_x, 32)); pio_sm_put(bus_data->pio, bus_data->pio_sm, 0); pio_sm_exec(bus_data->pio, bus_data->pio_sm, pio_encode_out(pio_y, 32)); pio_sm_exec(bus_data->pio, bus_data->pio_sm, pio_encode_jmp(bus_data->pio_offset)); dma_channel_abort(bus_data->dma_out); dma_channel_config out_config = dma_channel_get_default_config(bus_data->dma_out); channel_config_set_bswap(&out_config, true); channel_config_set_dreq(&out_config, pio_get_dreq(bus_data->pio, bus_data->pio_sm, true)); dma_channel_configure(bus_data->dma_out, &out_config, &bus_data->pio->txf[0], tx, tx_length / 4, true); bus_data->pio->fdebug = 1u << PIO_FDEBUG_TXSTALL_LSB; pio_sm_set_enabled(bus_data->pio, bus_data->pio_sm, true); while (!(bus_data->pio->fdebug & (1u << PIO_FDEBUG_TXSTALL_LSB))) { tight_loop_contents(); // todo timeout } __compiler_memory_barrier(); pio_sm_set_enabled(bus_data->pio, bus_data->pio_sm, false); pio_sm_set_consecutive_pindirs(bus_data->pio, bus_data->pio_sm, DATA_IN_PIN, 1, false); } else if (rx != NULL) { /* currently do one at a time */ DUMP_SPI_TRANSACTIONS( printf("[%lu] bus TX %u bytes:", counter++, rx_length); dump_bytes(rx, rx_length); ) panic_unsupported(); } pio_sm_exec(bus_data->pio, bus_data->pio_sm, pio_encode_mov(pio_pins, pio_null)); // for next time we turn output on stop_spi_comms(); DUMP_SPI_TRANSACTIONS( printf("RXed:"); dump_bytes(rx, rx_length); printf("\n"); ) return 0; } // Initialise our gpios void cyw43_spi_gpio_setup(void) { // Setup WL_REG_ON (23) gpio_init(WL_REG_ON); gpio_set_dir(WL_REG_ON, GPIO_OUT); gpio_pull_up(WL_REG_ON); // Setup DO, DI and IRQ (24) gpio_init(DATA_OUT_PIN); gpio_set_dir(DATA_OUT_PIN, GPIO_OUT); gpio_put(DATA_OUT_PIN, false); // Setup CS (25) gpio_init(CS_PIN); gpio_set_dir(CS_PIN, GPIO_OUT); gpio_put(CS_PIN, true); } // Reset wifi chip void cyw43_spi_reset(void) { gpio_put(WL_REG_ON, false); // off sleep_ms(20); gpio_put(WL_REG_ON, true); // on sleep_ms(250); // Setup IRQ (24) - also used for DO, DI gpio_init(IRQ_PIN); gpio_set_dir(IRQ_PIN, GPIO_IN); } static inline uint32_t make_cmd(bool write, bool inc, uint32_t fn, uint32_t addr, uint32_t sz) { return write << 31 | inc << 30 | fn << 28 | (addr & 0x1ffff) << 11 | sz; } #if CYW43_VERBOSE_DEBUG static const char *func_name(int fn) { switch (fn) { case BUS_FUNCTION: return "BUS_FUNCTION"; case BACKPLANE_FUNCTION: return "BACKPLANE_FUNCTION"; case WLAN_FUNCTION: return "WLAN_FUNCTION"; default: return "UNKNOWN"; } } #endif uint32_t read_reg_u32_swap(cyw43_int_t *self, uint32_t fn, uint32_t reg) { uint32_t buf[2] = {0}; assert(fn != BACKPLANE_FUNCTION); buf[0] = SWAP32(make_cmd(false, true, fn, reg, 4)); int ret = cyw43_spi_transfer(self, NULL, 4, (uint8_t *)buf, 8); if (ret != 0) { return ret; } return SWAP32(buf[1]); } static inline uint32_t _cyw43_read_reg(cyw43_int_t *self, uint32_t fn, uint32_t reg, uint size) { // Padding plus max read size of 32 bits + another 4? static_assert(WHD_BUS_SPI_BACKPLANE_READ_PADD_SIZE % 4 == 0, ""); uint32_t buf32[WHD_BUS_SPI_BACKPLANE_READ_PADD_SIZE/4 + 1 + 1]; uint8_t *buf = (uint8_t *)buf32; const uint32_t padding = (fn == BACKPLANE_FUNCTION) ? WHD_BUS_SPI_BACKPLANE_READ_PADD_SIZE : 0; // Add response delay buf32[0] = make_cmd(false, true, fn, reg, size + padding); if (fn == BACKPLANE_FUNCTION) { logic_debug_set(pin_BACKPLANE_READ, 1); } int ret = cyw43_spi_transfer(self, NULL, 4, buf, 8 + padding); if (fn == BACKPLANE_FUNCTION) { logic_debug_set(pin_BACKPLANE_READ, 0); } if (ret != 0) { return ret; } uint32_t result = buf32[padding > 0 ? 2 : 1]; CYW43_VDEBUG("cyw43_read_reg_u%d %s 0x%lx=0x%lx\n", size * 8, func_name(fn), reg, result); return result; } uint32_t cyw43_read_reg_u32(cyw43_int_t *self, uint32_t fn, uint32_t reg) { return _cyw43_read_reg(self, fn, reg, 4); } int cyw43_read_reg_u16(cyw43_int_t *self, uint32_t fn, uint32_t reg) { return _cyw43_read_reg(self, fn, reg, 2); } int cyw43_read_reg_u8(cyw43_int_t *self, uint32_t fn, uint32_t reg) { return _cyw43_read_reg(self, fn, reg, 1); } // This is only used to switch the word order on boot int write_reg_u32_swap(cyw43_int_t *self, uint32_t fn, uint32_t reg, uint32_t val) { uint32_t buf[2]; // Boots up in little endian so command needs swapping too buf[0] = SWAP32(make_cmd(true, true, fn, reg, 4)); buf[1] = SWAP32(val); int ret = cyw43_spi_transfer(self, (uint8_t *)buf, 8, NULL, 0); CYW43_VDEBUG("write_reg_u32_swap %s 0x%lx=0x%lx\n", func_name(fn), reg, val); return ret; } static inline int _cyw43_write_reg(cyw43_int_t *self, uint32_t fn, uint32_t reg, uint32_t val, uint size) { uint32_t buf[2]; buf[0] = make_cmd(true, true, fn, reg, size); buf[1] = val; if (fn == BACKPLANE_FUNCTION) { // In case of f1 overflow self->last_size = 8; self->last_header[0] = buf[0]; self->last_header[1] = buf[1]; self->last_backplane_window = self->cur_backplane_window; } if (fn == BACKPLANE_FUNCTION) { logic_debug_set(pin_BACKPLANE_WRITE, 1); } int ret = cyw43_spi_transfer(self, (uint8_t *)buf, 8, NULL, 0); if (fn == BACKPLANE_FUNCTION) { logic_debug_set(pin_BACKPLANE_WRITE, 0); } CYW43_VDEBUG("cyw43_write_reg_u%d %s 0x%lx=0x%lx\n", size * 8, func_name(fn), reg, val); return ret; } int cyw43_write_reg_u32(cyw43_int_t *self, uint32_t fn, uint32_t reg, uint32_t val) { return _cyw43_write_reg(self, fn, reg, val, 4); } int cyw43_write_reg_u16(cyw43_int_t *self, uint32_t fn, uint32_t reg, uint16_t val) { return _cyw43_write_reg(self, fn, reg, val, 2); } int cyw43_write_reg_u8(cyw43_int_t *self, uint32_t fn, uint32_t reg, uint32_t val) { return _cyw43_write_reg(self, fn, reg, val, 1); } #if MAX_BLOCK_SIZE > 0x7f8 #error Block size is wrong for SPI #endif // Assumes we're reading into spid_buf int cyw43_read_bytes(cyw43_int_t *self, uint32_t fn, uint32_t addr, size_t len, uint8_t *buf) { assert(fn != BACKPLANE_FUNCTION || (len <= 64 && (addr + len) <= 0x8000)); const uint32_t padding = (fn == BACKPLANE_FUNCTION) ? 4 : 0; // Add response delay size_t aligned_len = (len + 3) & ~3; assert(aligned_len > 0 && aligned_len <= 0x7f8); self->spi_header[padding > 0 ? 0 : 1] = make_cmd(false, true, fn, addr, len + padding); if (fn == WLAN_FUNCTION) { logic_debug_set(pin_WIFI_RX, 1); } int ret = cyw43_spi_transfer(self, NULL, 4, (uint8_t *)&self->spi_header[padding > 0 ? 0 : 1], aligned_len + 4 + padding); if (fn == WLAN_FUNCTION) { logic_debug_set(pin_WIFI_RX, 0); } if (ret != 0) { printf("cyw43_read_bytes error %d", ret); return ret; } if (buf != self->spid_buf) { // avoid a copy in the usual case just to add the header memcpy(buf, self->spid_buf, len); } return 0; } // See whd_bus_spi_transfer_bytes // Note, uses spid_buf if src isn't using it already // Apart from firmware download this appears to only be used for wlan functions? int cyw43_write_bytes(cyw43_int_t *self, uint32_t fn, uint32_t addr, size_t len, const uint8_t *src) { assert(fn != BACKPLANE_FUNCTION || (len <= 64 && (addr + len) <= 0x8000)); size_t aligned_len = (len + 3) & ~3u; assert(aligned_len > 0 && aligned_len <= 0x7f8); if (fn == WLAN_FUNCTION) { // Wait for FIFO to be ready to accept data int f2_ready_attempts = 1000; while (f2_ready_attempts-- > 0) { uint32_t bus_status = cyw43_read_reg_u32(self, BUS_FUNCTION, SPI_STATUS_REGISTER); if (bus_status & STATUS_F2_RX_READY) { logic_debug_set(pin_F2_RX_READY_WAIT, 0); break; } else { logic_debug_set(pin_F2_RX_READY_WAIT, 1); } } if (f2_ready_attempts <= 0) { printf("F2 not ready\n"); return CYW43_FAIL_FAST_CHECK(-CYW43_EIO); } } if (src == self->spid_buf) { // avoid a copy in the usual case just to add the header self->spi_header[1] = make_cmd(true, true, fn, addr, len); logic_debug_set(pin_WIFI_TX, 1); int res = cyw43_spi_transfer(self, (uint8_t *)&self->spi_header[1], aligned_len + 4, NULL, 0); logic_debug_set(pin_WIFI_TX, 0); return res; } else { // todo: would be nice to get rid of this. Only used for firmware download? assert(src < self->spid_buf || src >= (self->spid_buf + sizeof(self->spid_buf))); self->spi_header[1] = make_cmd(true, true, fn, addr, len); memcpy(self->spid_buf, src, len); return cyw43_spi_transfer(self, (uint8_t *)&self->spi_header[1], aligned_len + 4, NULL, 0); } } #endif