nvram-spi_8h_source.html

/*

 * SPDX-FileCopyrightText: 2015 Eistec AB

 * SPDX-License-Identifier: LGPL-2.1-only

 */


#pragma once


#include <stdint.h>

#include "nvram.h"

#include "periph/spi.h"

#include "periph/gpio.h"


#ifdef __cplusplus

extern "C" {

#endif


typedef struct nvram_spi_params {

    spi_t spi;

    spi_clk_t clk;

    gpio_t cs;

    uint8_t address_count;

} nvram_spi_params_t;


int nvram_spi_init(nvram_t *dev, nvram_spi_params_t *spi_params, size_t size);


#ifdef __cplusplus

}

#endif


spi_clk_t
spi_clk_t
Definition periph_cpu.h:348

gpio.h
Low-level GPIO peripheral driver interface definitions.

nvram_t
struct nvram nvram_t
Device descriptor for generic NVRAM devices.

nvram_spi_params_t
struct nvram_spi_params nvram_spi_params_t
Bus parameters for SPI NVRAM.

nvram_spi_init
int nvram_spi_init(nvram_t *dev, nvram_spi_params_t *spi_params, size_t size)
Initialize an nvram_t structure with SPI settings.

nvram.h
Generic non-volatile RAM driver interface.

spi.h
Low-level SPI peripheral driver interface definition.

nvram_spi_params
Bus parameters for SPI NVRAM.
Definition nvram-spi.h:34

nvram_spi_params::address_count
uint8_t address_count
Number of address bytes following each read/write command.
Definition nvram-spi.h:42

nvram_spi_params::cs
gpio_t cs
Chip select pin.
Definition nvram-spi.h:40

nvram_spi_params::spi
spi_t spi
RIOT SPI device.
Definition nvram-spi.h:36

nvram_spi_params::clk
spi_clk_t clk
SPI clock speed.
Definition nvram-spi.h:38