firmware: standardize recursive struct+typedef usage

Author: antoinevg

firmware/common/i2c_bus.h

@@ -25,21 +25,18 @@
 #include <stddef.h>
 #include <stdint.h>
 
-struct i2c_bus_t; // IWYU pragma: keep - fixed in #1704
-typedef struct i2c_bus_t i2c_bus_t;
-
-struct i2c_bus_t {
+typedef struct _i2c_bus_t {
 	void* const obj;
-	void (*start)(i2c_bus_t* const bus, const void* const config);
-	void (*stop)(i2c_bus_t* const bus);
+	void (*start)(struct _i2c_bus_t* const bus, const void* const config);
+	void (*stop)(struct _i2c_bus_t* const bus);
 	void (*transfer)(
-		i2c_bus_t* const bus,
+		struct _i2c_bus_t* const bus,
 		const uint_fast8_t peripheral_address,
 		const uint8_t* const tx,
 		const size_t tx_count,
 		uint8_t* const rx,
 		const size_t rx_count);
-};
+} i2c_bus_t;
 
 void i2c_bus_start(i2c_bus_t* const bus, const void* const config);
 void i2c_bus_stop(i2c_bus_t* const bus);

firmware/common/max2831.h

@@ -47,22 +47,21 @@ typedef enum {
 	MAX2831_RX_HPF_600_KHZ = 3,
 } max2831_rx_hpf_freq_t;
 
-struct max2831_driver_t; // IWYU pragma: keep - fixed in #1704
-typedef struct max2831_driver_t max2831_driver_t;
-
-struct max2831_driver_t {
+typedef struct _max2831_driver_t {
 	spi_bus_t* bus;
 	gpio_t gpio_enable;
 	gpio_t gpio_rxtx;
 	gpio_t gpio_rxhp;
 	gpio_t gpio_ld;
-	void (*target_init)(max2831_driver_t* const drv);
-	void (*set_mode)(max2831_driver_t* const drv, const max2831_mode_t new_mode);
+	void (*target_init)(struct _max2831_driver_t* const drv);
+	void (*set_mode)(
+		struct _max2831_driver_t* const drv,
+		const max2831_mode_t new_mode);
 	max2831_mode_t mode;
 	uint16_t regs[MAX2831_NUM_REGS];
 	uint16_t regs_dirty;
 	uint32_t desired_lpf_bw;
-};
+} max2831_driver_t;
 
 /* Initialize chip. */
 extern void max2831_setup(max2831_driver_t* const drv);

firmware/common/max2837.h

@@ -40,20 +40,19 @@ typedef enum {
 	MAX2837_MODE_RX
 } max2837_mode_t;
 
-struct max2837_driver_t; // IWYU pragma: keep - fixed in #1704
-typedef struct max2837_driver_t max2837_driver_t;
-
-struct max2837_driver_t {
+typedef struct _max2837_driver_t {
 	spi_bus_t* bus;
 	gpio_t gpio_enable;
 	gpio_t gpio_rx_enable;
 	gpio_t gpio_tx_enable;
-	void (*target_init)(max2837_driver_t* const drv);
-	void (*set_mode)(max2837_driver_t* const drv, const max2837_mode_t new_mode);
+	void (*target_init)(struct _max2837_driver_t* const drv);
+	void (*set_mode)(
+		struct _max2837_driver_t* const drv,
+		const max2837_mode_t new_mode);
 	max2837_mode_t mode;
 	uint16_t regs[MAX2837_NUM_REGS];
 	uint32_t regs_dirty;
-};
+} max2837_driver_t;
 
 /* Initialize chip. */
 extern void max2837_setup(max2837_driver_t* const drv);

firmware/common/max2839.h

@@ -43,19 +43,18 @@ typedef enum {
 	MAX2839_MODE_CLKOUT,
 } max2839_mode_t;
 
-struct max2839_driver_t; // IWYU pragma: keep - fixed in #1704
-typedef struct max2839_driver_t max2839_driver_t;
-
-struct max2839_driver_t {
+typedef struct _max2839_driver_t {
 	spi_bus_t* bus;
 	gpio_t gpio_enable;
 	gpio_t gpio_rxtx;
-	void (*target_init)(max2839_driver_t* const drv);
-	void (*set_mode)(max2839_driver_t* const drv, const max2839_mode_t new_mode);
+	void (*target_init)(struct _max2839_driver_t* const drv);
+	void (*set_mode)(
+		struct _max2839_driver_t* const drv,
+		const max2839_mode_t new_mode);
 	max2839_mode_t mode;
 	uint16_t regs[MAX2839_NUM_REGS];
 	uint32_t regs_dirty;
-};
+} max2839_driver_t;
 
 /* Initialize chip. */
 extern void max2839_setup(max2839_driver_t* const drv);

firmware/common/max5864.h

@@ -24,13 +24,10 @@
 
 #include "spi_bus.h"
 
-struct max5864_driver_t; // IWYU pragma: keep - fixed in #1704
-typedef struct max5864_driver_t max5864_driver_t;
-
-struct max5864_driver_t {
+typedef struct _max5864_driver_t {
 	spi_bus_t* const bus;
-	void (*target_init)(max5864_driver_t* const drv);
-};
+	void (*target_init)(struct _max5864_driver_t* const drv);
+} max5864_driver_t;
 
 void max5864_setup(max5864_driver_t* const drv);
 

firmware/common/spi_bus.h

@@ -29,20 +29,20 @@ typedef struct {
 	const size_t count;
 } spi_transfer_t;
 
-struct spi_bus_t; // IWYU pragma: keep - fixed in #1704
-typedef struct spi_bus_t spi_bus_t;
-
-struct spi_bus_t {
+typedef struct _spi_bus_t {
 	void* const obj;
 	const void* config;
-	void (*start)(spi_bus_t* const bus, const void* const config);
-	void (*stop)(spi_bus_t* const bus);
-	void (*transfer)(spi_bus_t* const bus, void* const data, const size_t count);
+	void (*start)(struct _spi_bus_t* const bus, const void* const config);
+	void (*stop)(struct _spi_bus_t* const bus);
+	void (*transfer)(
+		struct _spi_bus_t* const bus,
+		void* const data,
+		const size_t count);
 	void (*transfer_gather)(
-		spi_bus_t* const bus,
+		struct _spi_bus_t* const bus,
 		const spi_transfer_t* const transfers,
 		const size_t count);
-};
+} spi_bus_t;
 
 void spi_bus_start(spi_bus_t* const bus, const void* const config);
 void spi_bus_stop(spi_bus_t* const bus);

firmware/common/usb_queue.h

@@ -29,27 +29,25 @@
 
 #include "usb_type.h"
 
-typedef struct _usb_transfer_t usb_transfer_t;
-typedef struct _usb_queue_t usb_queue_t;
 typedef void (*transfer_completion_cb)(void*, unsigned int);
 
 // This is an opaque datatype. Thou shall not touch these members.
-struct _usb_transfer_t {
+typedef struct _usb_transfer_t {
 	struct _usb_transfer_t* next;
 	usb_transfer_descriptor_t td ATTR_ALIGNED(64);
 	unsigned int maximum_length;
 	struct _usb_queue_t* queue;
 	transfer_completion_cb completion_cb;
 	void* user_data;
-};
+} usb_transfer_t;
 
 // This is an opaque datatype. Thou shall not touch these members.
-struct _usb_queue_t {
-	struct usb_endpoint_t* endpoint;
+typedef struct _usb_queue_t {
+	usb_endpoint_t* endpoint;
 	const unsigned int pool_size;
 	usb_transfer_t* volatile free_transfers;
 	usb_transfer_t* volatile active;
-};
+} usb_queue_t;
 
 #define USB_DECLARE_QUEUE(endpoint_name) struct _usb_queue_t endpoint_name##_queue;
 #define USB_DEFINE_QUEUE(endpoint_name, _pool_size)                   \

firmware/common/usb_type.h

@@ -144,15 +144,13 @@ typedef struct {
 	uint8_t* wcid_extended_properties_descriptor;
 } usb_device_t;
 
-typedef struct usb_endpoint_t usb_endpoint_t;
-
-struct usb_endpoint_t {
+typedef struct _usb_endpoint_t {
 	usb_setup_t setup;
 	uint8_t buffer[32]; // Buffer for use during IN stage.
 	const uint_fast8_t address;
 	usb_device_t* const device;
-	usb_endpoint_t* const in;
-	usb_endpoint_t* const out;
-	void (*setup_complete)(usb_endpoint_t* const endpoint);
-	void (*transfer_complete)(usb_endpoint_t* const endpoint);
-};
+	struct _usb_endpoint_t* const in;
+	struct _usb_endpoint_t* const out;
+	void (*setup_complete)(struct _usb_endpoint_t* const endpoint);
+	void (*transfer_complete)(struct _usb_endpoint_t* const endpoint);
+} usb_endpoint_t;

firmware/common/w25q80bv.h

@@ -39,18 +39,15 @@ typedef union {
 	uint8_t id_8b[8];   /* 8*8bits 64bits Unique ID */
 } w25q80bv_unique_id_t;
 
-struct w25q80bv_driver_t; // IWYU pragma: keep - fixed in #1704
-typedef struct w25q80bv_driver_t w25q80bv_driver_t;
-
-struct w25q80bv_driver_t {
+typedef struct _w25q80bv_driver_t {
 	spi_bus_t* bus;
 	gpio_t gpio_hold;
 	gpio_t gpio_wp;
-	void (*target_init)(w25q80bv_driver_t* const drv);
+	void (*target_init)(struct _w25q80bv_driver_t* const drv);
 	size_t page_len;
 	size_t num_pages;
 	size_t num_bytes;
-};
+} w25q80bv_driver_t;
 
 void w25q80bv_setup(w25q80bv_driver_t* const drv);
 void w25q80bv_get_full_status(w25q80bv_driver_t* const drv, uint8_t* data);