Skip to content

nrf: Rewrite the SPI common-hal using nrfx #959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tannewt merged 1 commit into from
Jun 26, 2018
Merged

nrf: Rewrite the SPI common-hal using nrfx #959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions ports/nrf/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,14 @@ INC += -I$(BUILD)
INC += -I$(BUILD)/genhdr
INC += -I./../../lib/cmsis/inc
INC += -I./boards/$(BOARD)
INC += -I./device
INC += -I./device/$(MCU_VARIANT)
INC += -I./hal
INC += -I./hal/$(MCU_VARIANT)
INC += -I./modules/ubluepy
INC += -I./modules/random
INC += -I./modules/ble
INC += -I./nrfx
INC += -I./nrfx/hal
INC += -I./nrfx/mdk
INC += -I./nrfx/drivers/include
INC += -I../../lib/mp-readline
INC += -I./drivers/bluetooth
INC += -I./drivers
Expand Down Expand Up @@ -91,8 +92,6 @@ LIBS += -L $(dir $(LIBGCC_FILE_NAME)) -lgcc
SRC_HAL = $(addprefix hal/,\
hal_uart.c \
hal_uarte.c \
hal_spi.c \
hal_spie.c \
hal_time.c \
hal_timer.c \
hal_twi.c \
Expand All @@ -104,6 +103,10 @@ SRC_HAL = $(addprefix hal/,\
hal_pwm.c \
)

SRC_NRFX = $(addprefix nrfx/,\
drivers/src/nrfx_spim.c \
)

SRC_C += \
mphalport.c \
help.c \
Expand Down Expand Up @@ -219,6 +222,7 @@ FROZEN_MPY_MPY_FILES := $(addprefix $(BUILD)/,$(FROZEN_MPY_PY_FILES:.py=.mpy))
OBJ += $(PY_O) $(SUPERVISOR_O) $(addprefix $(BUILD)/, $(SRC_C:.c=.o))
OBJ += $(BUILD)/pins_gen.o
OBJ += $(addprefix $(BUILD)/, $(SRC_HAL:.c=.o))
OBJ += $(addprefix $(BUILD)/, $(SRC_NRFX:.c=.o))
OBJ += $(addprefix $(BUILD)/, $(DRIVERS_SRC_C:.c=.o))
OBJ += $(addprefix $(BUILD)/, $(SRC_COMMON_HAL_EXPANDED:.c=.o))
OBJ += $(addprefix $(BUILD)/, $(SRC_SHARED_MODULE_EXPANDED:.c=.o))
Expand Down
230 changes: 110 additions & 120 deletions ports/nrf/common-hal/busio/SPI.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* Copyright (c) 2015 Arduino LLC
* Copyright (c) 2016 Sandeep Mistry All right reserved.
* Copyright (c) 2017 hathach
* Copyright (c) 2018 Artur Pacholec
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
Expand All @@ -19,94 +20,111 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/


#include "shared-bindings/busio/SPI.h"
#include "py/mperrno.h"
#include "py/runtime.h"

#include "nrf.h"
#include "pins.h"

// Convert frequency to clock-speed-dependent value. Return 0 if out of range.
static uint32_t baudrate_to_reg(const uint32_t baudrate) {
uint32_t value;

if (baudrate <= 125000) {
value = SPI_FREQUENCY_FREQUENCY_K125;
} else if (baudrate <= 250000) {
value = SPI_FREQUENCY_FREQUENCY_K250;
} else if (baudrate <= 500000) {
value = SPI_FREQUENCY_FREQUENCY_K500;
} else if (baudrate <= 1000000) {
value = SPI_FREQUENCY_FREQUENCY_M1;
} else if (baudrate <= 2000000) {
value = SPI_FREQUENCY_FREQUENCY_M2;
} else if (baudrate <= 4000000) {
value = SPI_FREQUENCY_FREQUENCY_M4;
} else {
value = SPI_FREQUENCY_FREQUENCY_M8;
}
#include "nrfx_spim.h"
#include "nrf_gpio.h"

#if NRFX_SPIM3_ENABLED
#define INST_NO 3
#else
#define INST_NO 2
#endif

// Convert frequency to clock-speed-dependent value
static nrf_spim_frequency_t baudrate_to_spim_frequency(const uint32_t baudrate) {
if (baudrate <= 125000)
return NRF_SPIM_FREQ_125K;

if (baudrate <= 250000)
return NRF_SPIM_FREQ_250K;

if (baudrate <= 500000)
return NRF_SPIM_FREQ_500K;

if (baudrate <= 1000000)
return NRF_SPIM_FREQ_1M;

if (baudrate <= 2000000)
return NRF_SPIM_FREQ_2M;

if (baudrate <= 4000000)
return NRF_SPIM_FREQ_4M;

if (baudrate <= 8000000)
return NRF_SPIM_FREQ_8M;

#ifdef SPIM_FREQUENCY_FREQUENCY_M16
if (baudrate <= 16000000)
return NRF_SPIM_FREQ_16M;
#endif

return value;
#ifdef SPIM_FREQUENCY_FREQUENCY_M32
return NRF_SPIM_FREQ_32M;
#else
return NRF_SPIM_FREQ_8M;
#endif
}

void common_hal_busio_spi_construct(busio_spi_obj_t *self, const mcu_pin_obj_t * clock, const mcu_pin_obj_t * mosi, const mcu_pin_obj_t * miso) {
const nrfx_spim_t instance = NRFX_SPIM_INSTANCE(INST_NO);
self->spim = instance;

// 1 for I2C, 0 for SPI
self->spi = NRF_SPI0;
nrfx_spim_config_t config = NRFX_SPIM_DEFAULT_CONFIG;
config.frequency = NRF_SPIM_FREQ_8M;

self->spi->PSELSCK = clock->pin;
self->spi->PSELMOSI = mosi->pin;
self->spi->PSELMISO = miso->pin;
config.sck_pin = NRF_GPIO_PIN_MAP(clock->port, clock->pin);

if (mosi != (mcu_pin_obj_t*)&mp_const_none_obj)
config.mosi_pin = NRF_GPIO_PIN_MAP(mosi->port, mosi->pin);

#if NRF52840_XXAA
self->spi->PSELSCK |= (clock->port << SPI_PSEL_SCK_PORT_Pos);
self->spi->PSELMOSI |= (mosi->port << SPI_PSEL_MOSI_PORT_Pos);
self->spi->PSELMISO |= (miso->port << SPI_PSEL_MISO_PORT_Pos);
#endif
if (miso != (mcu_pin_obj_t*)&mp_const_none_obj)
config.miso_pin = NRF_GPIO_PIN_MAP(miso->port, miso->pin);

nrfx_err_t err = nrfx_spim_init(&self->spim, &config, NULL, NULL);

// A soft reset doesn't uninit the driver so we might end up with a invalid state
if (err == NRFX_ERROR_INVALID_STATE) {
nrfx_spim_uninit(&self->spim);
err = nrfx_spim_init(&self->spim, &config, NULL, NULL);
}

if (err != NRFX_SUCCESS)
mp_raise_OSError(MP_EIO);

self->inited = true;
}

bool common_hal_busio_spi_deinited(busio_spi_obj_t *self) {
return self->spi == NULL;
return !self->inited;
}

void common_hal_busio_spi_deinit(busio_spi_obj_t *self) {
if (common_hal_busio_spi_deinited(self)) {
if (common_hal_busio_spi_deinited(self))
return;
}

#ifdef NRF52840_XXAA
self->spi->PSEL.SCK = SPI_PSEL_SCK_CONNECT_Disconnected;
self->spi->PSEL.MOSI = SPI_PSEL_MOSI_CONNECT_Disconnected;
self->spi->PSEL.MISO = SPI_PSEL_MISO_CONNECT_Disconnected;
#else
self->spi->PSELSCK = SPI_PSEL_SCK_PSELSCK_Disconnected;
self->spi->PSELMOSI = SPI_PSEL_MOSI_PSELMOSI_Disconnected;
self->spi->PSELMISO = SPI_PSEL_MISO_PSELMISO_Disconnected;
#endif
// reset_pin(self->clock_pin);
// reset_pin(self->MOSI_pin);
// reset_pin(self->MISO_pin);
nrfx_spim_uninit(&self->spim);

self->spi = NULL;
self->inited = false;
}

bool common_hal_busio_spi_configure(busio_spi_obj_t *self, uint32_t baudrate, uint8_t polarity, uint8_t phase, uint8_t bits) {
// nrf52 does not support 16 bit
if ( bits != 8 ) return false;

self->spi->ENABLE = (SPI_ENABLE_ENABLE_Disabled << SPI_ENABLE_ENABLE_Pos);
if (bits != 8)
return false;

uint32_t config = (SPI_CONFIG_ORDER_MsbFirst << SPI_CONFIG_ORDER_Pos);
nrf_spim_frequency_set(self->spim.p_reg, baudrate_to_spim_frequency(baudrate));

config |= ((polarity ? SPI_CONFIG_CPOL_ActiveLow : SPI_CONFIG_CPOL_ActiveHigh) << SPI_CONFIG_CPOL_Pos);
config |= ((phase ? SPI_CONFIG_CPHA_Trailing : SPI_CONFIG_CPHA_Leading ) << SPI_CONFIG_CPHA_Pos);

self->spi->CONFIG = config;
self->spi->FREQUENCY = baudrate_to_reg(baudrate);
nrf_spim_mode_t mode = NRF_SPIM_MODE_0;
if (polarity) {
mode = (phase) ? NRF_SPIM_MODE_3 : NRF_SPIM_MODE_2;
} else {
mode = (phase) ? NRF_SPIM_MODE_1 : NRF_SPIM_MODE_0;
}

self->spi->ENABLE = (SPI_ENABLE_ENABLE_Enabled << SPI_ENABLE_ENABLE_Pos);
nrf_spim_configure(self->spim.p_reg, mode, NRF_SPIM_BIT_ORDER_MSB_FIRST);

return true;
}
Expand All @@ -131,87 +149,59 @@ void common_hal_busio_spi_unlock(busio_spi_obj_t *self) {
}

bool common_hal_busio_spi_write(busio_spi_obj_t *self, const uint8_t *data, size_t len) {
if (len == 0) {
return true;
}

while (len)
{
self->spi->TXD = *data;
if (len == 0)
return true;

while(!self->spi->EVENTS_READY);

(void) self->spi->RXD;
data++;
len--;

self->spi->EVENTS_READY = 0x0UL;
}
const nrfx_spim_xfer_desc_t xfer = NRFX_SPIM_XFER_TX(data, len);
const nrfx_err_t err = nrfx_spim_xfer(&self->spim, &xfer, 0);

return true;
return (err == NRFX_SUCCESS);
}

bool common_hal_busio_spi_read(busio_spi_obj_t *self, uint8_t *data, size_t len, uint8_t write_value) {
if (len == 0) {
return true;
}

while (len)
{
self->spi->TXD = write_value;
if (len == 0)
return true;

while(!self->spi->EVENTS_READY);
const nrfx_spim_xfer_desc_t xfer = NRFX_SPIM_XFER_RX(data, len);
const nrfx_err_t err = nrfx_spim_xfer(&self->spim, &xfer, 0);

*data = self->spi->RXD;

data++;
len--;

self->spi->EVENTS_READY = 0x0UL;
}

return true;
return (err == NRFX_SUCCESS);
}

bool common_hal_busio_spi_transfer(busio_spi_obj_t *self, uint8_t *data_out, uint8_t *data_in, size_t len) {
if (len == 0) {
return true;
}

while (len)
{
self->spi->TXD = *data_out;

while(!self->spi->EVENTS_READY);

*data_in = self->spi->RXD;
if (len == 0)
return true;

data_out++;
data_in++;
len--;
const nrfx_spim_xfer_desc_t xfer = NRFX_SPIM_SINGLE_XFER(data_out, len, data_in, len);
const nrfx_err_t err = nrfx_spim_xfer(&self->spim, &xfer, 0);

self->spi->EVENTS_READY = 0x0UL;
}

return true;
return (err == NRFX_SUCCESS);
}

uint32_t common_hal_busio_spi_get_frequency(busio_spi_obj_t* self) {
switch (self->spi->FREQUENCY) {
case SPI_FREQUENCY_FREQUENCY_K125:
switch (self->spim.p_reg->FREQUENCY) {
case NRF_SPIM_FREQ_125K:
return 125000;
case SPI_FREQUENCY_FREQUENCY_K250:
case NRF_SPIM_FREQ_250K:
return 250000;
case SPI_FREQUENCY_FREQUENCY_K500:
case NRF_SPIM_FREQ_500K:
return 500000;
case SPI_FREQUENCY_FREQUENCY_M1:
case NRF_SPIM_FREQ_1M:
return 1000000;
case SPI_FREQUENCY_FREQUENCY_M2:
case NRF_SPIM_FREQ_2M:
return 2000000;
case SPI_FREQUENCY_FREQUENCY_M4:
case NRF_SPIM_FREQ_4M:
return 4000000;
case SPI_FREQUENCY_FREQUENCY_M8:
case NRF_SPIM_FREQ_8M:
return 8000000;
#ifdef SPIM_FREQUENCY_FREQUENCY_M16
case NRF_SPIM_FREQ_16M:
return 16000000;
#endif
#ifdef SPIM_FREQUENCY_FREQUENCY_M32
case NRF_SPIM_FREQ_32M:
return 32000000;
#endif
default:
return 0;
}
Expand Down
8 changes: 3 additions & 5 deletions ports/nrf/common-hal/busio/SPI.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,13 @@
#ifndef MICROPY_INCLUDED_NRF_COMMON_HAL_BUSIO_SPI_H
#define MICROPY_INCLUDED_NRF_COMMON_HAL_BUSIO_SPI_H

#include "common-hal/microcontroller/Pin.h"

//#include "hal/include/hal_spi_m_sync.h"

#include "nrfx_spim.h"
#include "py/obj.h"

typedef struct {
mp_obj_base_t base;
NRF_SPI_Type *spi;
nrfx_spim_t spim;
bool inited;
bool has_lock;
} busio_spi_obj_t;

Expand Down
Loading