source: rtems/c/src/lib/libbsp/powerpc/gen5200/mscan/mscan.h @ 9807f04

4.104.114.84.95
Last change on this file since 9807f04 was c9b005a9, checked in by Thomas Doerfler <Thomas.Doerfler@…>, on 07/09/06 at 10:05:27

applied patches for PR1117/1118/1119/1120

  • Property mode set to 100644
File size: 12.0 KB
Line 
1/*===============================================================*\
2| Project: RTEMS generic MPC5200 BSP                              |
3+-----------------------------------------------------------------+
4| Partially based on the code references which are named below.   |
5| Adaptions, modifications, enhancements and any recent parts of  |
6| the code are:                                                   |
7|                    Copyright (c) 2005                           |
8|                    Embedded Brains GmbH                         |
9|                    Obere Lagerstr. 30                           |
10|                    D-82178 Puchheim                             |
11|                    Germany                                      |
12|                    rtems@embedded-brains.de                     |
13+-----------------------------------------------------------------+
14| The license and distribution terms for this file may be         |
15| found in the file LICENSE in this distribution or at            |
16|                                                                 |
17| http://www.rtems.com/license/LICENSE.                           |
18|                                                                 |
19+-----------------------------------------------------------------+
20| this file declares stuff for the mscan driver                   |
21\*===============================================================*/
22#ifndef __MSCAN_H__
23#define __MSCAN_H__
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29#define MIN_NO_OF_TQ         7
30#define NO_OF_TABLE_ENTRIES  4
31#define TSEG_1               1
32#define TSEG_2               2
33#define SJW                  3
34
35#define MSCAN_MAX_DATA_BYTES     8
36#define MSCAN_RX_BUFF_NUM        4
37#define MSCAN_TX_BUFF_NUM        3
38
39
40#define MSCAN_A_DEV_NAME         "/dev/mscana"
41#define MSCAN_B_DEV_NAME         "/dev/mscanb"
42#define MSCAN_0_DEV_NAME         "/dev/mscan0"
43#define MSCAN_1_DEV_NAME         "/dev/mscan1"
44#define MSCAN_A                  0
45#define MSCAN_B                  1
46
47#define MSCAN_NON_INITIALIZED_MODE   0
48#define MSCAN_INITIALIZED_MODE       1
49#define MSCAN_INIT_NORMAL_MODE       2
50#define MSCAN_NORMAL_MODE            4
51#define MSCAN_SLEEP_MODE             8
52
53#define CAN_BIT_RATE_MAX         1000000
54#define CAN_BIT_RATE_MIN         100000
55
56#define CAN_BIT_RATE             100000
57#define CAN_MAX_NO_OF_TQ         25
58#define CAN_MAX_NO_OF_TQ_TSEG1   15
59#define CAN_MAX_NO_OF_TQ_TSEG2   7
60#define CAN_MAX_NO_OF_TQ_SJW     2
61
62#define MSCAN_SET_RX_ID          1
63#define MSCAN_GET_RX_ID          2
64#define MSCAN_SET_RX_ID_MASK     3
65#define MSCAN_GET_RX_ID_MASK     4
66#define MSCAN_SET_TX_ID          5
67#define MSCAN_GET_TX_ID          6
68
69#define TOUCAN_MSCAN_INIT        7
70#define MSCAN_SET_BAUDRATE       8
71#define SET_TX_BUF_NO            9
72
73#define MSCAN_RX_BUFF_NOACTIVE   (0 << 4)
74#define MSCAN_RX_BUFF_EMPTY      (1 << 6)
75#define MSCAN_RX_BUFF_FULL       (1 << 5)
76#define MSCAN_RX_BUFF_OVERRUN    ((MSCAN_RX_BUFF_EMPTY) | (MSCAN_RX_BUFF_FULL))
77#define MSCAN_RX_BUFF_BUSY       (1 << 4)
78
79#define MSCAN_MBUFF_MASK         0x07
80
81#define MSCAN_TX_BUFF0           (1 << 0)
82#define MSCAN_TX_BUFF1           (1 << 1)
83#define MSCAN_TX_BUFF2           (1 << 2)
84
85#define MSCAN_IDE                (1 << 0)
86#define MSCAN_RTR                (1 << 1)
87#define MSCAN_READ_RXBUFF_0      (1 << 2)
88#define MSCAN_READ_RXBUFF_1      (1 << 2)
89#define MSCAN_READ_RXBUFF_2      (1 << 2)
90#define MSCAN_READ_RXBUFF_3      (1 << 2)
91
92#define CTL0_RXFRM               (1 << 7)
93#define CTL0_RXACT               (1 << 6)
94#define CTL0_CSWAI               (1 << 5)
95#define CTL0_SYNCH               (1 << 4)
96#define CTL0_TIME                (1 << 3)
97#define CTL0_WUPE                (1 << 2)
98#define CTL0_SLPRQ               (1 << 1)
99#define CTL0_INITRQ              (1 << 0)
100
101#define CTL1_CANE                (1 << 7)
102#define CTL1_CLKSRC              (1 << 6)
103#define CTL1_LOOPB               (1 << 5)
104#define CTL1_LISTEN              (1 << 4)
105#define CTL1_WUPM                (1 << 2)
106#define CTL1_SLPAK               (1 << 1)
107#define CTL1_INITAK              (1 << 0)
108
109#define BTR0_SJW(btr0)           ((btr0) << 6)
110#define BTR0_BRP(btr0)           ((btr0) << 0)
111
112#define BTR1_SAMP                (1 << 7)
113#define BTR1_TSEG_22_20(btr1)    ((btr1) << 4)
114#define BTR1_TSEG_13_10(btr1)    ((btr1) << 0)
115
116#define RFLG_WUPIF               (1 << 7)
117#define RFLG_CSCIF               (1 << 6)
118#define RFLG_RSTAT               (3 << 4)
119#define RFLG_TSTAT               (3 << 2)
120#define RFLG_OVRIF               (1 << 1)
121#define RFLG_RXF                 (1 << 0)
122#define RFLG_GET_RX_STATE(rflg)  (((rflg) >> 4) & 0x03)
123#define RFLG_GET_TX_STATE(rflg)  (((rflg) >> 2) & 0x03)
124
125#define MSCAN_STATE_OK           0
126#define MSCAN_STATE_ERR          1
127#define MSCAN_STATE_WRN              2
128#define MSCAN_STATE_BUSOFF       3
129
130#define RIER_WUPIE               (1 << 7)
131#define RIER_CSCIE               (1 << 6)
132#define RIER_RSTAT(rier)         ((rier) << 4)
133#define RIER_TSTAT(rier)         ((rier) << 2)
134#define RIER_OVRIE               (1 << 1)
135#define RIER_RXFIE               (1 << 0)
136
137#define TFLG_TXE2                (1 << 2)
138#define TFLG_TXE1                (1 << 1)
139#define TFLG_TXE0                (1 << 0)
140
141#define TIER_TXEI2               (1 << 2)
142#define TIER_TXEI1               (1 << 1)
143#define TIER_TXEI0               (1 << 0)
144
145#define TARQ_ABTRQ2              (1 << 2)
146#define TARQ_ABTRQ1              (1 << 1)
147#define TARQ_ABTRQ0              (1 << 0)
148
149#define TAAK_ABTRQ2              (1 << 2)
150#define TAAK_ABTRQ1              (1 << 1)
151#define TAAK_ABTRQ0              (1 << 0)
152
153#define BSEL_TX2                 (1 << 2)
154#define BSEL_TX1                 (1 << 1)
155#define BSEL_TX0                 (1 << 0)
156
157#define IDAC_IDAM1               (1 << 5)
158#define IDAC_IDAM0               (1 << 4)
159#define IDAC_IDHIT(idac)         ((idac) & 0x7)
160
161#define TX_MBUF_SEL(buf_no)      (1 << (buf_no))
162#define TX_DATA_LEN(len)         ((len) & 0x0F)
163
164#define TX_MBUF_EMPTY(val)       (1 << (val))
165
166#define TXIDR1_IDE               (1 << 3)
167#define TXIDR1_SRR               (1 << 4)
168
169#define TXIDR3_RTR               (1 << 0)
170#define TXIDR1_RTR               (1 << 4)
171
172#define RXIDR1_IDE               (1 << 3)
173#define RXIDR1_SRR               (1 << 4)
174
175#define RXIDR3_RTR               (1 << 0)
176#define RXIDR1_RTR               (1 << 4)
177
178#define SET_IDR0(u16)            ((uint8_t)((u16) >> 3))
179#define SET_IDR1(u16)            ((uint8_t)(((u16) & 0x0007) << 5))
180
181#define SET_IDR2(u16)            SET_IDR0(u16)
182#define SET_IDR3(u16)            SET_IDR1(u16)
183
184#define SET_IDR4(u16)            SET_IDR0(u16)
185#define SET_IDR5(u16)            SET_IDR1(u16)
186
187#define SET_IDR6(u16)            SET_IDR0(u16)
188#define SET_IDR7(u16)            SET_IDR1(u16)
189
190#define GET_IDR0(u16)            ((uint16_t) ((u16) << 3))
191#define GET_IDR1(u16)            ((uint16_t)(((u16) >> 5)&0x0007))
192
193#define GET_IDR2(u16)            GET_IDR0(u16)
194#define GET_IDR3(u16)            GET_IDR1(u16)
195
196#define GET_IDR4(u16)            GET_IDR0(u16)
197#define GET_IDR5(u16)            GET_IDR1(u16)
198
199#define GET_IDR6(u16)            GET_IDR0(u16)
200#define GET_IDR7(u16)            GET_IDR1(u16)
201
202#define SET_IDMR0(u16)           ((uint8_t)((u16) >> 3))
203#define SET_IDMR1(u16)           ((uint8_t)((((u16) & 0x0007) << 5))|0x001F)
204
205#define SET_IDMR2(u16)           SET_IDMR0(u16)
206#define SET_IDMR3(u16)           SET_IDMR1(u16)
207
208#define SET_IDMR4(u16)           SET_IDMR0(u16)
209#define SET_IDMR5(u16)           SET_IDMR1(u16)
210
211#define SET_IDMR6(u16)           SET_IDMR0(u16)
212#define SET_IDMR7(u16)           SET_IDMR1(u16)
213
214#define GET_IDMR0(u16)           ((uint16_t) ((u16) << 3))
215#define GET_IDMR1(u16)           ((uint16_t)(((u16) >> 5)&0x0007))
216
217#define GET_IDMR2(u16)           GET_IDMR0(u16)
218#define GET_IDMR3(u16)           GET_IDMR1(u16)
219
220#define GET_IDMR4(u16)           GET_IDMR0(u16)
221#define GET_IDMR5(u16)           GET_IDMR1(u16)
222
223#define GET_IDMR6(u16)           GET_IDMR0(u16)
224#define GET_IDMR7(u16)           GET_IDMR1(u16)
225
226#define NO_OF_MSCAN_RX_BUFF      20
227#define MSCAN_MESSAGE_SIZE(size) (((size)%CPU_ALIGNMENT) ? (((size) + CPU_ALIGNMENT)-((size) + CPU_ALIGNMENT)%CPU_ALIGNMENT) : (size))
228
229#define TX_BUFFER_0              0
230#define TX_BUFFER_1              1
231#define TX_BUFFER_2              2
232
233#define RX_BUFFER_0              0
234#define RX_BUFFER_1              1
235#define RX_BUFFER_2              2
236#define RX_BUFFER_3              3
237
238#define NO_OF_MSCAN_TX_BUFF      20
239#define RING_BUFFER_EMPTY(rbuff) ((((rbuff)->head) == ((rbuff)->tail)) ? TRUE : FALSE)
240#define RING_BUFFER_FULL(rbuff)  ((((rbuff)->head) == ((rbuff)->tail)) ? TRUE : FALSE)
241
242
243typedef struct _mscan_handle
244  {
245  uint8_t mscan_channel;
246  void (*toucan_callback)(int16_t);
247  } mscan_handle;
248
249struct can_message
250  {
251    /* uint16_t mess_len; */
252  uint16_t mess_id;
253  uint16_t mess_time_stamp;
254  uint8_t  mess_data[MSCAN_MAX_DATA_BYTES];
255  uint8_t  mess_len;
256  uint32_t toucan_tx_id;
257  };
258
259volatile struct ring_buf
260    {
261    volatile struct can_message *buf_ptr;
262    volatile struct can_message *head_ptr;
263    volatile struct can_message *tail_ptr;
264    };
265
266struct mpc5200_rx_cntrl
267  {
268  struct can_message can_rx_message[MSCAN_RX_BUFF_NUM];
269  };
270
271struct mscan_channel_info
272  {
273  volatile struct mpc5200_mscan *regs;
274  uint32_t   int_rx_err;
275  rtems_id   rx_qid;
276  uint32_t   rx_qname;
277  rtems_id   tx_rb_sid;
278  uint32_t   tx_rb_sname;
279  uint8_t    id_extended;
280  uint8_t    mode;
281  uint8_t    tx_buf_no;
282  volatile struct ring_buf tx_ring_buf;
283  };
284
285struct mscan_rx_parms
286  {
287  struct can_message *rx_mess;
288  uint32_t rx_timeout;
289  uint8_t  rx_flags;
290  };
291
292struct mscan_tx_parms
293  {
294  struct can_message *tx_mess;
295  uint32_t tx_id;
296  };
297
298struct mscan_ctrl_parms
299  {
300    uint32_t ctrl_id;
301    uint32_t ctrl_id_mask;
302    uint8_t  ctrl_reg_no;
303    uint8_t  ctrl_tx_buf_no;
304    uint32_t ctrl_can_bitrate;
305    void (*toucan_cb_fnc)(int16_t);
306  };
307
308
309extern void CanInterrupt_A(int16_t);
310extern void CanInterrupt_B(int16_t);
311
312
313rtems_device_driver mscan_initialize( rtems_device_major_number,
314                                                      rtems_device_minor_number,
315                                                      void *
316                                                    );
317
318rtems_device_driver mscan_open( rtems_device_major_number,
319                                                rtems_device_minor_number,
320                                                void *
321                                              );
322
323rtems_device_driver mscan_close( rtems_device_major_number,
324                                                 rtems_device_minor_number,
325                                                 void *
326                                           );
327
328rtems_device_driver mscan_read( rtems_device_major_number,
329                                                rtems_device_minor_number,
330                                                void *
331                                              );
332
333rtems_device_driver mscan_write( rtems_device_major_number,
334                                                 rtems_device_minor_number,
335                                                 void *
336                                               );
337
338rtems_device_driver mscan_control( rtems_device_major_number,
339                                                   rtems_device_minor_number,
340                                                   void *
341                                                 );
342
343
344#define MSCAN_DRIVER_TABLE_ENTRY \
345  { mscan_initialize, mscan_open, mscan_close, \
346    mscan_read, mscan_write, mscan_control }
347
348/*MSCAN driver internal functions */
349void mscan_hardware_initialize(rtems_device_major_number, uint32_t, void *);
350void mpc5200_mscan_int_enable(volatile struct mpc5200_mscan *);
351void mpc5200_mscan_int_disable(volatile struct mpc5200_mscan *);
352void mpc5200_mscan_enter_sleep_mode(volatile struct mpc5200_mscan *);
353void mpc5200_mscan_exit_sleep_mode(volatile struct mpc5200_mscan *);
354void mpc5200_mscan_enter_init_mode(volatile struct mpc5200_mscan *);
355void mpc5200_mscan_exit_init_mode(volatile struct mpc5200_mscan *);
356void mpc5200_mscan_wait_sync(volatile struct mpc5200_mscan *);
357void mpc5200_mscan_perform_init_mode_settings(volatile struct mpc5200_mscan *);
358void mpc5200_mscan_perform_normal_mode_settings(volatile struct mpc5200_mscan *);
359rtems_status_code mpc5200_mscan_set_mode(rtems_device_minor_number, uint8_t);
360rtems_status_code mscan_channel_initialize(rtems_device_major_number, rtems_device_minor_number);
361uint8_t prescaler_calculation(uint32_t, uint32_t, uint8_t *);
362void mpc5200_mscan_perform_bit_time_settings(volatile struct mpc5200_mscan *, uint32_t, uint32_t);
363
364
365#ifdef __cplusplus
366}
367#endif
368
369#endif /* __MSCAN_H__ */
Note: See TracBrowser for help on using the repository browser.