xref: /linux/drivers/net/can/cc770/cc770.h (revision cbecf716ca618fd44feda6bd9a64a8179d031fc5)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Core driver for the CC770 and AN82527 CAN controllers
4  *
5  * Copyright (C) 2009, 2011 Wolfgang Grandegger <wg@grandegger.com>
6  */
7 
8 #ifndef CC770_DEV_H
9 #define CC770_DEV_H
10 
11 #include <linux/can/dev.h>
12 
13 struct cc770_msgobj {
14 	u8 ctrl0;
15 	u8 ctrl1;
16 	u8 id[4];
17 	u8 config;
18 	u8 data[8];
19 	u8 dontuse;		/* padding */
20 } __packed;
21 
22 struct cc770_regs {
23 	union {
24 		struct cc770_msgobj msgobj[16]; /* Message object 1..15 */
25 		struct {
26 			u8 control;		/* Control Register */
27 			u8 status;		/* Status Register */
28 			u8 cpu_interface;	/* CPU Interface Register */
29 			u8 dontuse1;
30 			u8 high_speed_read[2];	/* High Speed Read */
31 			u8 global_mask_std[2];	/* Standard Global Mask */
32 			u8 global_mask_ext[4];	/* Extended Global Mask */
33 			u8 msg15_mask[4];	/* Message 15 Mask */
34 			u8 dontuse2[15];
35 			u8 clkout;		/* Clock Out Register */
36 			u8 dontuse3[15];
37 			u8 bus_config;		/* Bus Configuration Register */
38 			u8 dontuse4[15];
39 			u8 bit_timing_0;	/* Bit Timing Register byte 0 */
40 			u8 dontuse5[15];
41 			u8 bit_timing_1;	/* Bit Timing Register byte 1 */
42 			u8 dontuse6[15];
43 			u8 interrupt;		/* Interrupt Register */
44 			u8 dontuse7[15];
45 			u8 rx_error_counter;	/* Receive Error Counter */
46 			u8 dontuse8[15];
47 			u8 tx_error_counter;	/* Transmit Error Counter */
48 			u8 dontuse9[31];
49 			u8 p1_conf;
50 			u8 dontuse10[15];
51 			u8 p2_conf;
52 			u8 dontuse11[15];
53 			u8 p1_in;
54 			u8 dontuse12[15];
55 			u8 p2_in;
56 			u8 dontuse13[15];
57 			u8 p1_out;
58 			u8 dontuse14[15];
59 			u8 p2_out;
60 			u8 dontuse15[15];
61 			u8 serial_reset_addr;
62 		};
63 	};
64 } __packed;
65 
66 /* Control Register (0x00) */
67 #define CTRL_INI	0x01	/* Initialization */
68 #define CTRL_IE		0x02	/* Interrupt Enable */
69 #define CTRL_SIE	0x04	/* Status Interrupt Enable */
70 #define CTRL_EIE	0x08	/* Error Interrupt Enable */
71 #define CTRL_EAF	0x20	/* Enable additional functions */
72 #define CTRL_CCE	0x40	/* Change Configuration Enable */
73 
74 /* Status Register (0x01) */
75 #define STAT_LEC_STUFF	0x01	/* Stuff error */
76 #define STAT_LEC_FORM	0x02	/* Form error */
77 #define STAT_LEC_ACK	0x03	/* Acknowledgement error */
78 #define STAT_LEC_BIT1	0x04	/* Bit1 error */
79 #define STAT_LEC_BIT0	0x05	/* Bit0 error */
80 #define STAT_LEC_CRC	0x06	/* CRC error */
81 #define STAT_LEC_MASK	0x07	/* Last Error Code mask */
82 #define STAT_TXOK	0x08	/* Transmit Message Successfully */
83 #define STAT_RXOK	0x10	/* Receive Message Successfully */
84 #define STAT_WAKE	0x20	/* Wake Up Status */
85 #define STAT_WARN	0x40	/* Warning Status */
86 #define STAT_BOFF	0x80	/* Bus Off Status */
87 
88 /*
89  * CPU Interface Register (0x02)
90  * Clock Out Register (0x1f)
91  * Bus Configuration Register (0x2f)
92  *
93  * see include/linux/can/platform/cc770.h
94  */
95 
96 /* Message Control Register 0 (Base Address + 0x0) */
97 #define INTPND_RES	0x01	/* No Interrupt pending */
98 #define INTPND_SET	0x02	/* Interrupt pending */
99 #define INTPND_UNC	0x03
100 #define RXIE_RES	0x04	/* Receive Interrupt Disable */
101 #define RXIE_SET	0x08	/* Receive Interrupt Enable */
102 #define RXIE_UNC	0x0c
103 #define TXIE_RES	0x10	/* Transmit Interrupt Disable */
104 #define TXIE_SET	0x20	/* Transmit Interrupt Enable */
105 #define TXIE_UNC	0x30
106 #define MSGVAL_RES	0x40	/* Message Invalid */
107 #define MSGVAL_SET	0x80	/* Message Valid */
108 #define MSGVAL_UNC	0xc0
109 
110 /* Message Control Register 1 (Base Address + 0x01) */
111 #define NEWDAT_RES	0x01	/* No New Data */
112 #define NEWDAT_SET	0x02	/* New Data */
113 #define NEWDAT_UNC	0x03
114 #define MSGLST_RES	0x04	/* No Message Lost */
115 #define MSGLST_SET	0x08	/* Message Lost */
116 #define MSGLST_UNC	0x0c
117 #define CPUUPD_RES	0x04	/* No CPU Updating */
118 #define CPUUPD_SET	0x08	/* CPU Updating */
119 #define CPUUPD_UNC	0x0c
120 #define TXRQST_RES	0x10	/* No Transmission Request */
121 #define TXRQST_SET	0x20	/* Transmission Request */
122 #define TXRQST_UNC	0x30
123 #define RMTPND_RES	0x40	/* No Remote Request Pending */
124 #define RMTPND_SET	0x80	/* Remote Request Pending */
125 #define RMTPND_UNC	0xc0
126 
127 /* Message Configuration Register (Base Address + 0x06) */
128 #define MSGCFG_XTD	0x04	/* Extended Identifier */
129 #define MSGCFG_DIR	0x08	/* Direction is Transmit */
130 
131 #define MSGOBJ_FIRST	1
132 #define MSGOBJ_LAST	15
133 
134 #define CC770_IO_SIZE	0x100
135 #define CC770_MAX_IRQ	20	/* max. number of interrupts handled in ISR */
136 #define CC770_MAX_MSG	4	/* max. number of messages handled in ISR */
137 
138 #define CC770_ECHO_SKB_MAX	1
139 
140 #define cc770_read_reg(priv, member)					\
141 	priv->read_reg(priv, offsetof(struct cc770_regs, member))
142 
143 #define cc770_write_reg(priv, member, value)				\
144 	priv->write_reg(priv, offsetof(struct cc770_regs, member), value)
145 
146 /*
147  * Message objects and flags used by this driver
148  */
149 #define CC770_OBJ_FLAG_RX	0x01
150 #define CC770_OBJ_FLAG_RTR	0x02
151 #define CC770_OBJ_FLAG_EFF	0x04
152 
153 enum {
154 	CC770_OBJ_RX0 = 0,	/* for receiving normal messages */
155 	CC770_OBJ_RX1,		/* for receiving normal messages */
156 	CC770_OBJ_RX_RTR0,	/* for receiving remote transmission requests */
157 	CC770_OBJ_RX_RTR1,	/* for receiving remote transmission requests */
158 	CC770_OBJ_TX,		/* for sending messages */
159 	CC770_OBJ_MAX
160 };
161 
162 #define obj2msgobj(o)	(MSGOBJ_LAST - (o)) /* message object 11..15 */
163 
164 /*
165  * CC770 private data structure
166  */
167 struct cc770_priv {
168 	struct can_priv can;	/* must be the first member */
169 	struct sk_buff *echo_skb;
170 
171 	/* the lower-layer is responsible for appropriate locking */
172 	u8 (*read_reg)(const struct cc770_priv *priv, int reg);
173 	void (*write_reg)(const struct cc770_priv *priv, int reg, u8 val);
174 	void (*pre_irq)(const struct cc770_priv *priv);
175 	void (*post_irq)(const struct cc770_priv *priv);
176 
177 	void *priv;		/* for board-specific data */
178 	struct net_device *dev;
179 
180 	void __iomem *reg_base;	 /* ioremap'ed address to registers */
181 	unsigned long irq_flags; /* for request_irq() */
182 
183 	unsigned char obj_flags[CC770_OBJ_MAX];
184 	u8 control_normal_mode;	/* Control register for normal mode */
185 	u8 cpu_interface;	/* CPU interface register */
186 	u8 clkout;		/* Clock out register */
187 	u8 bus_config;		/* Bus configuration register */
188 
189 	struct sk_buff *tx_skb;
190 };
191 
192 struct net_device *alloc_cc770dev(int sizeof_priv);
193 void free_cc770dev(struct net_device *dev);
194 int register_cc770dev(struct net_device *dev);
195 void unregister_cc770dev(struct net_device *dev);
196 
197 #endif /* CC770_DEV_H */
198