xref: /linux/drivers/net/wireless/morsemicro/mm81x/bus.h (revision 91ec2035134982b98fab0609a9fd8480e8217dc1)
1*b1906ceaSLachlan Hodges /* SPDX-License-Identifier: GPL-2.0-only */
2*b1906ceaSLachlan Hodges /*
3*b1906ceaSLachlan Hodges  * Copyright (c) 2017-2026 Morse Micro
4*b1906ceaSLachlan Hodges  */
5*b1906ceaSLachlan Hodges 
6*b1906ceaSLachlan Hodges #ifndef _MM81X_BUS_H_
7*b1906ceaSLachlan Hodges #define _MM81X_BUS_H_
8*b1906ceaSLachlan Hodges 
9*b1906ceaSLachlan Hodges #include <linux/skbuff.h>
10*b1906ceaSLachlan Hodges #include "core.h"
11*b1906ceaSLachlan Hodges 
12*b1906ceaSLachlan Hodges enum mm81x_bus_type {
13*b1906ceaSLachlan Hodges 	MM81X_BUS_TYPE_USB,
14*b1906ceaSLachlan Hodges 	MM81X_BUS_TYPE_SDIO,
15*b1906ceaSLachlan Hodges };
16*b1906ceaSLachlan Hodges 
17*b1906ceaSLachlan Hodges struct mm81x_bus_ops {
18*b1906ceaSLachlan Hodges 	int (*dm_read)(struct mm81x *mors, u32 addr, u8 *data, int len);
19*b1906ceaSLachlan Hodges 	int (*dm_write)(struct mm81x *mors, u32 addr, const u8 *data, int len);
20*b1906ceaSLachlan Hodges 	int (*reg32_read)(struct mm81x *mors, u32 addr, u32 *data);
21*b1906ceaSLachlan Hodges 	int (*reg32_write)(struct mm81x *mors, u32 addr, u32 data);
22*b1906ceaSLachlan Hodges 	int (*digital_reset)(struct mm81x *mors);
23*b1906ceaSLachlan Hodges 	void (*set_bus_enable)(struct mm81x *mors, bool enable);
24*b1906ceaSLachlan Hodges 	void (*config_burst_mode)(struct mm81x *mors, bool enable_burst);
25*b1906ceaSLachlan Hodges 	void (*claim)(struct mm81x *mors);
26*b1906ceaSLachlan Hodges 	void (*set_irq)(struct mm81x *mors, bool enable);
27*b1906ceaSLachlan Hodges 	void (*release)(struct mm81x *mors);
28*b1906ceaSLachlan Hodges 	unsigned int bulk_alignment;
29*b1906ceaSLachlan Hodges };
30*b1906ceaSLachlan Hodges 
31*b1906ceaSLachlan Hodges /*
32*b1906ceaSLachlan Hodges  * Default TX alignment for buses which don't care. mac80211 will give us
33*b1906ceaSLachlan Hodges  * SKBs aligned to the 2 byte boundary, so 2 is effectively a noop.
34*b1906ceaSLachlan Hodges  */
35*b1906ceaSLachlan Hodges #define MM81X_BUS_DEFAULT_BULK_ALIGNMENT (2)
36*b1906ceaSLachlan Hodges 
37*b1906ceaSLachlan Hodges /* mm81x_dm_read - len must be rounded up to the nearest 4-byte boundary */
mm81x_dm_read(struct mm81x * mors,u32 addr,u8 * data,int len)38*b1906ceaSLachlan Hodges static inline int mm81x_dm_read(struct mm81x *mors, u32 addr, u8 *data, int len)
39*b1906ceaSLachlan Hodges {
40*b1906ceaSLachlan Hodges 	return mors->bus_ops->dm_read(mors, addr, data, len);
41*b1906ceaSLachlan Hodges }
42*b1906ceaSLachlan Hodges 
mm81x_dm_write(struct mm81x * mors,u32 addr,const u8 * data,int len)43*b1906ceaSLachlan Hodges static inline int mm81x_dm_write(struct mm81x *mors, u32 addr, const u8 *data,
44*b1906ceaSLachlan Hodges 				 int len)
45*b1906ceaSLachlan Hodges {
46*b1906ceaSLachlan Hodges 	return mors->bus_ops->dm_write(mors, addr, data, len);
47*b1906ceaSLachlan Hodges }
48*b1906ceaSLachlan Hodges 
mm81x_reg32_read(struct mm81x * mors,u32 addr,u32 * data)49*b1906ceaSLachlan Hodges static inline int mm81x_reg32_read(struct mm81x *mors, u32 addr, u32 *data)
50*b1906ceaSLachlan Hodges {
51*b1906ceaSLachlan Hodges 	return mors->bus_ops->reg32_read(mors, addr, data);
52*b1906ceaSLachlan Hodges }
53*b1906ceaSLachlan Hodges 
mm81x_reg32_write(struct mm81x * mors,u32 addr,u32 data)54*b1906ceaSLachlan Hodges static inline int mm81x_reg32_write(struct mm81x *mors, u32 addr, u32 data)
55*b1906ceaSLachlan Hodges {
56*b1906ceaSLachlan Hodges 	return mors->bus_ops->reg32_write(mors, addr, data);
57*b1906ceaSLachlan Hodges }
58*b1906ceaSLachlan Hodges 
mm81x_bus_digital_reset(struct mm81x * mors)59*b1906ceaSLachlan Hodges static inline int mm81x_bus_digital_reset(struct mm81x *mors)
60*b1906ceaSLachlan Hodges {
61*b1906ceaSLachlan Hodges 	if (mors->bus_ops->digital_reset)
62*b1906ceaSLachlan Hodges 		return mors->bus_ops->digital_reset(mors);
63*b1906ceaSLachlan Hodges 
64*b1906ceaSLachlan Hodges 	return 0;
65*b1906ceaSLachlan Hodges }
66*b1906ceaSLachlan Hodges 
mm81x_set_bus_enable(struct mm81x * mors,bool enable)67*b1906ceaSLachlan Hodges static inline void mm81x_set_bus_enable(struct mm81x *mors, bool enable)
68*b1906ceaSLachlan Hodges {
69*b1906ceaSLachlan Hodges 	mors->bus_ops->set_bus_enable(mors, enable);
70*b1906ceaSLachlan Hodges }
71*b1906ceaSLachlan Hodges 
mm81x_bus_config_burst_mode(struct mm81x * mors,bool enable_burst)72*b1906ceaSLachlan Hodges static inline void mm81x_bus_config_burst_mode(struct mm81x *mors,
73*b1906ceaSLachlan Hodges 					       bool enable_burst)
74*b1906ceaSLachlan Hodges {
75*b1906ceaSLachlan Hodges 	if (mors->bus_ops->config_burst_mode)
76*b1906ceaSLachlan Hodges 		mors->bus_ops->config_burst_mode(mors, enable_burst);
77*b1906ceaSLachlan Hodges }
78*b1906ceaSLachlan Hodges 
mm81x_claim_bus(struct mm81x * mors)79*b1906ceaSLachlan Hodges static inline void mm81x_claim_bus(struct mm81x *mors)
80*b1906ceaSLachlan Hodges {
81*b1906ceaSLachlan Hodges 	mors->bus_ops->claim(mors);
82*b1906ceaSLachlan Hodges }
83*b1906ceaSLachlan Hodges 
mm81x_bus_set_irq(struct mm81x * mors,bool enable)84*b1906ceaSLachlan Hodges static inline void mm81x_bus_set_irq(struct mm81x *mors, bool enable)
85*b1906ceaSLachlan Hodges {
86*b1906ceaSLachlan Hodges 	mors->bus_ops->set_irq(mors, enable);
87*b1906ceaSLachlan Hodges }
88*b1906ceaSLachlan Hodges 
mm81x_release_bus(struct mm81x * mors)89*b1906ceaSLachlan Hodges static inline void mm81x_release_bus(struct mm81x *mors)
90*b1906ceaSLachlan Hodges {
91*b1906ceaSLachlan Hodges 	mors->bus_ops->release(mors);
92*b1906ceaSLachlan Hodges }
93*b1906ceaSLachlan Hodges 
mm81x_bus_get_alignment(struct mm81x * mors)94*b1906ceaSLachlan Hodges static inline unsigned int mm81x_bus_get_alignment(struct mm81x *mors)
95*b1906ceaSLachlan Hodges {
96*b1906ceaSLachlan Hodges 	return mors->bus_ops->bulk_alignment;
97*b1906ceaSLachlan Hodges }
98*b1906ceaSLachlan Hodges 
99*b1906ceaSLachlan Hodges #endif /* !_MM81X_BUS_H_ */
100