summaryrefslogtreecommitdiff
path: root/cmd/sbc_harness/hw/rp2040_hwspi.h
blob: 22ef6fad71b76c4dbd9e84f2c0ffd58c99dfd8c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#ifndef _RP2040_HWSPI_H_
#define _RP2040_HWSPI_H_

#include "hw/spi.h"

enum rp2040_hwspi_instance {
	RP2040_HWSPI_0 = 0,
	RP2040_HWSPI_1 = 1,
};

struct rp2040_hwspi {
 	struct spi_vtable      *vtable;

	void /*spi_inst_t*/    *inst;
	uint                    pin_cs;
};

/**
 * Initialize an instance of `struct rp2040_hwspi`.
 *
 * @param self     : struct rp2040_hwspi        : the structure to initialize
 * @param name     : char *                     : a name for the SPI port; to include in the bininfo
 * @param inst_num : enum rp2040_hwspi_instance : the PL220 instance number; RP2040_HWSPI_{0,1}
 * @param mode     : enum spi_mode              : the SPI mode; SPI_MODE_{0..3}
 * @param pin_miso : uint                       : pin number; 0, 4, 16, or 20 for _HWSPI_0; 8, 12, 24, or 28 for _HWSPI_1
 * @param pin_mosi : uint                       : pin number; 3, 7, 19, or 23 for _HWSPI_0; 11, 15, or 27 for _HWSPI_1
 * @param pin_clk  : uint                       : pin number; 2, 6, 18, or 22 for _HWSPI_0; 10, 14, or 26 for _HWSPI_1
 * @param pin_cs   : uint                       : pin number; any unused GPIO pin
 *
 * There is no bit-order argument; the RP2040's hardware SPI always
 * uses MSB-first bit order.
 */
#define rp2040_hwspi_init(self, name,                                    \
                          inst_num, mode, baudrate_hz,                   \
                          pin_miso, pin_mosi, pin_clk, pin_cs)           \
	do {                                                             \
		bi_decl(bi_4_pins_with_names(pin_miso, name" SPI MISO",  \
		                             pin_mosi, name" SPI MOSI",  \
		                             pin_mosi, name" SPI CLK",   \
		                             pin_mosi, name" SPI CS"));  \
		_rp2040_hwspi_init(self,                                 \
		                   inst_num, mode, baudrate_hz,          \
		                   pin_miso, pin_mosi, pin_c;k, pin_cs); \
	} while(0)
void _rp2040_hwspi_init(struct rp2040_hwspi *self,
                        enum rp2040_hwspi_instance inst_num,
                        enum spi_mode mode,
                        uint baudrate_hz,
                        uint pin_miso,
                        uint pin_mosi,
                        uint pin_clk,
                        uint pin_cs);

#endif /* _RP2040_HWSPI_H_ */