Training courses

Kernel and Embedded Linux

Bootlin training courses

Embedded Linux, kernel,
Yocto Project, Buildroot, real-time,
graphics, boot time, debugging...

Bootlin logo

Elixir Cross Referencer

  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
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
/*	$NetBSD: hd64570reg.h,v 1.11 2005/12/11 12:21:26 christos Exp $	*/

/*
 * Copyright (c) 1998 Vixie Enterprises
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of Vixie Enterprises nor the names
 *    of its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY VIXIE ENTERPRISES AND
 * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL VIXIE ENTERPRISES OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * This software has been written for Vixie Enterprises by Michael Graff
 * <explorer@flame.org>.  To learn more about Vixie Enterprises, see
 * ``http://www.vix.com''.
 */

#ifndef _DEV_IC_HD64570REG_H_
#define _DEV_IC_HD64570REG_H_

/* XXX
 * This is really HDLC specific stuff, but...
 */
#define CISCO_MULTICAST         0x8f    /* Cisco multicast address */
#define CISCO_UNICAST           0x0f    /* Cisco unicast address */
#define CISCO_KEEPALIVE         0x8035  /* Cisco keepalive protocol */
#define CISCO_ADDR_REQ          0       /* Cisco address request */
#define CISCO_ADDR_REPLY        1       /* Cisco address reply */
#define CISCO_KEEPALIVE_REQ     2       /* Cisco keepalive request */

struct cisco_pkt {
        u_int32_t	type;
        u_int32_t	par1;
        u_int32_t	par2;
        u_int16_t	rel;
        u_int16_t	time0;
        u_int16_t	time1;
};
#define CISCO_PKT_LEN	18	/* sizeof doesn't work right... */

#define HDLC_PROTOCOL_IP	0x0800	/* IP */
#define HDLC_PROTOCOL_IPV6	0x86dd	/* IPv6 */
#define HDLC_PROTOCOL_ISO	0xfefe	/* LLC_ISO_LSAP dsap,ssap */

struct hdlc_header {
	u_int8_t	h_addr;
	u_int8_t	h_resv;
	u_int16_t	h_proto;
};
#define HDLC_HDRLEN	4

struct hdlc_llc_header {
	u_int8_t	hl_addr;
	u_int8_t	hl_resv;
	u_int8_t	hl_dsap;
	u_int8_t	hl_ssap;
	u_int8_t	hl_ffb;		/* cisco: friendly fudge byte */
};

/*
 * Hitachi HD64570  defininitions
 */

/*  SCA Control Registers  */
#define  SCA_PABR0 2
#define  SCA_PABR1 3
#define  SCA_WCRL  4        /* Wait Control reg */
#define  SCA_WCRM  5        /* Wait Control reg */
#define  SCA_WCRH  6        /* Wait Control reg */
#define  SCA_PCR   8        /* DMA priority control reg */

/*   Interrupt registers  */
#define  SCA_ISR0   0x10    /* Interrupt status register 0  */
#define  SCA_ISR1   0x11    /* Interrupt status register 1  */
#define  SCA_ISR2   0x12    /* Interrupt status register 2  */
#define  SCA_IER0   0x14    /* Interrupt enable register 0  */
#define  SCA_IER1   0x15    /* Interrupt enable register 1  */
#define  SCA_IER2   0x16    /* Interrupt enable register 2  */
#define  SCA_ITCR   0x18    /* interrupt control register */
#define  SCA_IVR    0x1a    /* interrupt vector */
#define  SCA_IMVR   0x1c    /* modified interrupt vector */

/*  MSCI  Channel 0 Registers  */
#define  SCA_TRBL0  0x20    /* TX/RX buffer reg */
#define  SCA_TRBH0  0x21    /* TX/RX buffer reg */
#define  SCA_ST00   0x22     /* Status reg 0 */
#define  SCA_ST10   0x23     /* Status reg 1 */
#define  SCA_ST20   0x24     /* Status reg 2 */
#define  SCA_ST30   0x25     /* Status reg 3 */
#define  SCA_FST0   0x26     /* frame Status reg  */
#define  SCA_IE00   0x28     /* Interrupt enable reg 0 */
#define  SCA_IE10   0x29     /* Interrupt enable reg 1 */
#define  SCA_IE20   0x2a     /* Interrupt enable reg 2 */
#define  SCA_FIE0   0x2b     /* Frame Interrupt enable reg  */
#define  SCA_CMD0   0x2c     /* Command reg */
#define  SCA_MD00   0x2e     /* Mode reg 0 */
#define  SCA_MD10   0x2f     /* Mode reg 1 */
#define  SCA_MD20   0x30     /* Mode reg 2 */
#define  SCA_CTL0   0x31     /* Control reg */
#define  SCA_SA00   0x32     /* Syn Address reg 0 */
#define  SCA_SA10   0x33     /* Syn Address reg 1 */
#define  SCA_IDL0   0x34    /* Idle register */
#define  SCA_TMC0   0x35     /* Time constant */
#define  SCA_RXS0   0x36     /* RX clock source */
#define  SCA_TXS0   0x37     /* TX clock source */
#define  SCA_TRC00  0x38    /* TX Ready control reg 0 */
#define  SCA_TRC10  0x39    /* TX Ready control reg 1 */
#define  SCA_RRC0   0x3A    /* RX Ready control reg */

/*  MSCI  Channel 1 Registers  */
#define  SCA_TRBL1  0x40    /* TX/RX buffer reg */
#define  SCA_TRBH1  0x41    /* TX/RX buffer reg */
#define  SCA_ST01   0x42     /* Status reg 0 */
#define  SCA_ST11   0x43     /* Status reg 1 */
#define  SCA_ST21   0x44     /* Status reg 2 */
#define  SCA_ST31   0x45     /* Status reg 3 */
#define  SCA_FST1   0x46     /* Frame Status reg  */
#define  SCA_IE01   0x48     /* Interrupt enable reg 0 */
#define  SCA_IE11   0x49     /* Interrupt enable reg 1 */
#define  SCA_IE21   0x4a     /* Interrupt enable reg 2 */
#define  SCA_FIE1   0x4b     /* Frame Interrupt enable reg  */
#define  SCA_CMD1   0x4c     /* Command reg */
#define  SCA_MD01   0x4e     /* Mode reg 0 */
#define  SCA_MD11   0x4f     /* Mode reg 1 */
#define  SCA_MD21   0x50     /* Mode reg 2 */
#define  SCA_CTL1   0x51     /* Control reg */
#define  SCA_SA01   0x52     /* Syn Address reg 0 */
#define  SCA_SA11   0x53     /* Syn Address reg 1 */
#define  SCA_IDL1   0x54    /* Idle register */
#define  SCA_TMC1   0x55     /* Time constant */
#define  SCA_RXS1   0x56     /* RX clock source */
#define  SCA_TXS1   0x57     /* TX clock source */
#define  SCA_TRC01  0x58    /* TX Ready control reg 0 */
#define  SCA_TRC11  0x59    /* TX Ready control reg 1 */
#define  SCA_RRC1   0x5A    /* RX Ready control reg */


/*  SCA  DMA  registers  */

#define  SCA_DMER   0x9     /* DMA Master Enable reg */

/*   DMA   Channel 0   Registers (MSCI -> memory, or rx) */
#define  SCA_BARL0  0x80    /* buffer address reg  */
#define  SCA_BARH0  0x81    /* buffer address reg  */
#define  SCA_BARB0  0x82    /* buffer address reg  */
#define  SCA_DARL0  0x80    /* Dest. address reg  */
#define  SCA_DARH0  0x81    /* Dest. address reg  */
#define  SCA_DARB0  0x82    /* Dest. address reg  */
#define  SCA_CPB0   0x86    /* Chain pointer base  */
#define  SCA_CDAL0  0x88    /* Current descriptor address  */
#define  SCA_CDAH0  0x89    /* Current descriptor address  */
#define  SCA_EDAL0  0x8A    /* Error descriptor address  */
#define  SCA_EDAH0  0x8B    /* Error descriptor address  */
#define  SCA_BFLL0  0x8C    /* RX buffer length Low  */
#define  SCA_BFLH0  0x8D    /* RX buffer length High */
#define  SCA_BCRL0  0x8E    /* Byte Count reg  */
#define  SCA_BCRH0  0x8F    /* Byte Count reg  */
#define  SCA_DSR0   0x90    /* DMA Status reg  */
#define  SCA_DMR0   0x91    /* DMA Mode reg    */
#define  SCA_FCT0   0x93    /* Frame end interrupt Counter */
#define  SCA_DIR0   0x94    /* DMA interrupt enable */
#define  SCA_DCR0   0x95    /* DMA Command reg  */

/*   DMA  Channel 1   Registers (memory -> MSCI, or tx) */
#define  SCA_BARL1  0xA0    /* buffer address reg  */
#define  SCA_BARH1  0xA1    /* buffer address reg  */
#define  SCA_BARB1  0xA2    /* buffer address reg  */
#define  SCA_SARL1  0xA4    /* Source address reg  */
#define  SCA_SARH1  0xA5    /* Source address reg  */
#define  SCA_SARB1  0xA6    /* Source address reg  */
#define  SCA_CPB1   0xA6    /* Chain pointer base  */
#define  SCA_CDAL1  0xA8    /* Current descriptor address  */
#define  SCA_CDAH1  0xA9    /* Current descriptor address  */
#define  SCA_EDAL1  0xAA    /* Error descriptor address  */
#define  SCA_EDAH1  0xAB    /* Error descriptor address  */
#define  SCA_BCRL1  0xAE    /* Byte Count reg  */
#define  SCA_BCRH1  0xAF    /* Byte Count reg  */
#define  SCA_DSR1   0xB0    /* DMA Status reg  */
#define  SCA_DMR1   0xB1    /* DMA Mode reg    */
#define  SCA_FCT1   0xB3    /* Frame end interrupt Counter */
#define  SCA_DIR1   0xB4    /* DMA interrupt enable */
#define  SCA_DCR1   0xB5    /* DMA Command reg  */

/*   DMA   Channel 2   Registers (MSCI -> memory) */
#define  SCA_BARL2  0xC0    /* buffer address reg  */
#define  SCA_BARH2  0xC1    /* buffer address reg  */
#define  SCA_BARB2  0xC2    /* buffer address reg  */
#define	SCA_CDAL2	0xC8
#define  SCA_DSR2   0xD0    /* DMA Status reg  */

/*   DMA   Channel 3   Registers (memory -> MSCI) */
#define  SCA_BARL3  0xE0    /* buffer address reg  */
#define  SCA_BARH3  0xE1    /* buffer address reg  */
#define  SCA_BARB3  0xE2    /* buffer address reg  */
#define	SCA_CDAL3	0xE8
#define  SCA_DSR3   0xF0    /* DMA Status reg  */

/*
 * Timer Registers
 */

/* Timer up-counter */
#define	SCA_TCNTL0	0x60	/* channel 0 */
#define	SCA_TCNTH0	0x61	/* channel 0 */
#define	SCA_TCNTL1	0x68	/* channel 1 */
#define	SCA_TCNTH1	0x69	/* channel 1 */
#define	SCA_TCNTL2	0x70	/* channel 2 */
#define	SCA_TCNTH2	0x71	/* channel 2 */
#define	SCA_TCNTL3	0x78	/* channel 3 */
#define	SCA_TCNTH3	0x79	/* channel 3 */

/* Timer constant register */
#define	SCA_TCONRL0	0x62	/* channel 0 */
#define	SCA_TCONRH0	0x63	/* channel 0 */
#define	SCA_TCONRL1	0x6a	/* channel 1 */
#define	SCA_TCONRH1	0x6b	/* channel 1 */
#define	SCA_TCONRL2	0x72	/* channel 2 */
#define	SCA_TCONRH2	0x73	/* channel 2 */
#define	SCA_TCONRL3	0x7a	/* channel 3 */
#define	SCA_TCONRH3	0x7b	/* channel 3 */

/* Timer control/status register */
#define	SCA_TCSR0	0x64	/* channel 0 */
#define	SCA_TCSR1	0x6c	/* channel 1 */
#define	SCA_TCSR2	0x74	/* channel 2 */
#define	SCA_TCSR3	0x7c	/* channel 3 */

/* Timer expand prescale register */
#define	SCA_TEPR0	0x65	/* channel 0 */
#define	SCA_TEPR1	0x6d	/* channel 1 */
#define	SCA_TEPR2	0x75	/* channel 2 */
#define	SCA_TEPR3	0x7d	/* channel 3 */

/*
 * SCA HD64570 Register Definitions
 */

#define ST3_CTS   8    /* modem input  /CTS bit */
#define ST3_DCD   4    /* modem input  /DCD bit */

/*
 * SCA commands
 */
#define SCA_CMD_TXRESET         0x01
#define SCA_CMD_TXENABLE        0x02
#define SCA_CMD_TXDISABLE       0x03
#define SCA_CMD_TXCRCINIT       0x04
#define SCA_CMD_TXCRCEXCL       0x05
#define SCA_CMS_TXEOM           0x06
#define SCA_CMD_TXABORT         0x07
#define SCA_CMD_MPON            0x08
#define SCA_CMD_TXBCLEAR        0x09

#define SCA_CMD_RXRESET         0x11
#define SCA_CMD_RXENABLE        0x12
#define SCA_CMD_RXDISABLE       0x13
#define SCA_CMD_RXCRCINIT       0x14
#define SCA_CMD_RXMSGREJ        0x15
#define SCA_CMD_MPSEARCH        0x16
#define SCA_CMD_RXCRCEXCL       0x17
#define SCA_CMD_RXCRCCALC       0x18

#define SCA_CMD_NOP             0x00
#define SCA_CMD_RESET           0x21
#define SCA_CMD_SEARCH          0x31

#define SCA_MD0_CRC_1           0x01
#define SCA_MD0_CRC_CCITT       0x02
#define SCA_MD0_CRC_ENABLE      0x04
#define SCA_MD0_AUTO_ENABLE     0x10
#define SCA_MD0_MODE_ASYNC      0x00
#define SCA_MD0_MODE_BYTESYNC1  0x20
#define SCA_MD0_MODE_BISYNC     0x40
#define SCA_MD0_MODE_BYTESYNC2  0x60
#define SCA_MD0_MODE_HDLC       0x80

#define SCA_MD1_NOADDRCHK       0x00
#define SCA_MD1_SNGLADDR1       0x40
#define SCA_MD1_SNGLADDR2       0x80
#define SCA_MD1_DUALADDR        0xC0

#define SCA_MD2_DUPLEX          0x00
#define SCA_MD2_ECHO            0x01
#define SCA_MD2_LOOPBACK        0x03
#define SCA_MD2_ADPLLx8         0x00
#define SCA_MD2_ADPLLx16        0x08
#define SCA_MD2_ADPLLx32        0x10
#define SCA_MD2_NRZ             0x00
#define SCA_MD2_NRZI            0x20
#define SCA_MD2_MANCHESTER      0x80
#define SCA_MD2_FM0             0xC0
#define SCA_MD2_FM1             0xA0

#define	SCA_CTL_RTS_MASK	0x01	/* control state of RTS */
#define SCA_CTL_RTS_HIGH	0x00	/* raise RTS (low !RTS) */
#define SCA_CTL_RTS_LOW		0x01	/* lower RTS (raise !RTS) */
#define	SCA_CTL_IDLC_MASK	0x10	/* control idle state */
#define	SCA_CTL_IDLC_MARK	0x00	/* transmit mark in idle state */
#define SCA_CTL_IDLC_PATTERN	0x10	/* tranmist idle pattern */
#define SCA_CTL_UDRNC_MASK	0x20	/* control underrun state */
#define	SCA_CTL_UDRNC_AFTER_ABORT	0x00	/* idle after aborting trans */
#define SCA_CTL_UDRNC_AFTER_FCS	0x20	/* idle after FCS and flag trans */

#define SCA_RXS_DIV_MASK        0x0F	/* BRG divisor is 2^(value) */
#define SCA_RXS_DIV_1		0x00	/* 1 */
#define SCA_RXS_DIV_2		0x01	/* 2 */
#define SCA_RXS_DIV_4		0x02	/* 4 */
#define SCA_RXS_DIV_8		0x03	/* 8 */
#define SCA_RXS_DIV_16		0x04	/* 16 */
#define SCA_RXS_DIV_32		0x05	/* 32 */
#define SCA_RXS_DIV_64		0x06	/* 64 */
#define SCA_RXS_DIV_128		0x07	/* 128 */
#define SCA_RXS_DIV_256		0x08	/* 256 */
#define SCA_RXS_DIV_512		0x09	/* 512 */
#define SCA_RXS_CLK_MASK	0x70	/* which clock source */
#define SCA_RXS_CLK_LINE	0x00	/* RXC line input */
#define SCA_RXS_CLK_LINE_SN	0x20	/* RXC line with noise suppression */
#define SCA_RXS_CLK_INTERNAL	0x40	/* Baud Rate Gen. output */
#define SCA_RXS_CLK_ADPLL_OUT   0x60	/* BRG out for ADPLL clock */
#define SCA_RXS_CLK_ADPLL_IN    0x70	/* line input for ADPLL clock */

#define SCA_TXS_DIV_MASK	0x0F	/* BRG divisor is 2^(valud) */
#define SCA_TXS_DIV_1		0x00	/* 1 */
#define SCA_TXS_DIV_2		0x01	/* 2 */
#define SCA_TXS_DIV_4		0x02	/* 4 */
#define SCA_TXS_DIV_8		0x03	/* 8 */
#define SCA_TXS_DIV_16		0x04	/* 16 */
#define SCA_TXS_DIV_32		0x05	/* 32 */
#define SCA_TXS_DIV_64		0x06	/* 64 */
#define SCA_TXS_DIV_128		0x07	/* 128 */
#define SCA_TXS_DIV_256		0x08	/* 256 */
#define SCA_TXS_DIV_512		0x09	/* 512 */
#define SCA_TXS_CLK_MASK	0x70	/* which clock source */
#define SCA_TXS_CLK_LINE	0x00	/* TXC line input */
#define SCA_TXS_CLK_INTERNAL	0x40	/* Baud Rate Gen. output */
#define SCA_TXS_CLK_RXCLK	0x60	/* Receive clock */

#define SCA_ST0_RXRDY           0x01
#define SCA_ST0_TXRDY           0x02
#define SCA_ST0_RXINT           0x40
#define SCA_ST0_TXINT           0x80

#define SCA_ST1_IDLST           0x01
#define SCA_ST1_ABTST           0x02
#define SCA_ST1_DCDCHG          0x04
#define SCA_ST1_CTSCHG          0x08
#define SCA_ST1_FLAG            0x10
#define SCA_ST1_TXIDL           0x40
#define SCA_ST1_UDRN            0x80

/* ST2 and FST look the same */
#define SCA_FST_CRCERR          0x04
#define SCA_FST_OVRN            0x08
#define SCA_FST_RESFRM          0x10
#define SCA_FST_ABRT            0x20
#define SCA_FST_SHRT            0x40
#define SCA_FST_EOM             0x80

#define SCA_ST3_RXENA           0x01
#define SCA_ST3_TXENA           0x02
#define SCA_ST3_DCD             0x04
#define SCA_ST3_CTS             0x08
#define SCA_ST3_ADPLLSRCH       0x10
#define SCA_ST3_TXDATA          0x20

#define SCA_FIE_EOMFE           0x80

#define SCA_IE0_RXRDY           0x01
#define SCA_IE0_TXRDY           0x02
#define SCA_IE0_RXINT           0x40
#define SCA_IE0_TXINT           0x80

#define SCA_IE1_IDLDE           0x01
#define SCA_IE1_ABTDE           0x02
#define SCA_IE1_DCD             0x04
#define SCA_IE1_CTS             0x08
#define SCA_IE1_FLAG            0x10
#define SCA_IE1_IDL             0x40
#define SCA_IE1_UDRN            0x80

#define SCA_IE2_CRCERR          0x04
#define SCA_IE2_OVRN            0x08
#define SCA_IE2_RESFRM          0x10
#define SCA_IE2_ABRT            0x20
#define SCA_IE2_SHRT            0x40
#define SCA_IE2_EOM             0x80


/*
 * Interrupt status register bits
 */
#define	SCA_ISR0_MSCI_RXRDY0	0x01	/* rx ready port 0 int */
#define	SCA_ISR0_MSCI_TXRDY0	0x02	/* tx ready port 0 int */
#define	SCA_ISR0_MSCI_RXINT0	0x04	/* rx error port 0 int */
#define	SCA_ISR0_MSCI_TXINT0	0x08	/* tx error port 0 int */
#define	SCA_ISR0_MSCI_RXRDY1	0x10	/* rx ready port 1 int */
#define	SCA_ISR0_MSCI_TXRDY1	0x20	/* tx ready port 1 int */
#define	SCA_ISR0_MSCI_RXINT1	0x40	/* rx error port 1 int */
#define	SCA_ISR0_MSCI_TXINT1	0x80	/* tx error port 1 int */

#define	SCA_ISR1_DMAC_RX0A	0x01	/* dmac channel 0 int a */
#define	SCA_ISR1_DMAC_RX0B	0x02	/* dmac channel 0 int b */
#define	SCA_ISR1_DMAC_TX0A	0x04	/* dmac channel 1 int a */
#define	SCA_ISR1_DMAC_TX0B	0x08	/* dmac channel 1 int b */
#define	SCA_ISR1_DMAC_RX1A	0x10	/* dmac channel 2 int a */
#define	SCA_ISR1_DMAC_RX1B	0x20	/* dmac channel 2 int b */
#define	SCA_ISR1_DMAC_TX1A	0x40	/* dmac channel 3 int a */
#define	SCA_ISR1_DMAC_TX1B	0x80	/* dmac channel 3 int b */

#define	SCA_ISR2_TIMER_IRQ0	0x10	/* timer channel 0 int */
#define	SCA_ISR2_TIMER_IRQ1	0x20	/* timer channel 1 int */
#define	SCA_ISR2_TIMER_IRQ2	0x40	/* timer channel 2 int */
#define	SCA_ISR2_TIMER_IRQ3	0x80	/* timer channel 3 int */

/* masks/values for the Interrupt Control Register (ITCR) */
#define SCA_ITCR_INTR_PRI_MASK	0x80	/* priority of intrerrupts */
#define	SCA_ITCR_INTR_PRI_MSCI	0x00	/* msci over dmac */
#define	SCA_ITCR_INTR_PRI_DMAC	0x80	/* dmac over msci */
#define	SCA_ITCR_ACK_MASK	0x60	/* mask for intr ack cycle setting */
#define	SCA_ITCR_ACK_NONE	0x00	/* no intr ack cycle */
#define	SCA_ITCR_ACK_SINGLE	0x20	/* single intr ack cycle */
#define	SCA_ITCR_ACK_DOUBLE	0x40	/* double intr ack cycle */
#define	SCA_ITCR_ACK_RESV	0x60	/* reserverd */
#define	SCA_ITCR_VOUT_MASK	0x10	/* vector output */
#define	SCA_ITCR_VOUT_IVR	0x00	/* use IVR */
#define	SCA_ITCR_VOUT_IMVR	0x10	/* use IMVR */

/*
 * Interrupt enable register bits
 */
#define	SCA_IER0_MSCI_RXRDY0	0x01	/* enable rx ready port 0 int */
#define	SCA_IER0_MSCI_TXRDY0	0x02	/* enable tx ready port 0 int */
#define	SCA_IER0_MSCI_RXINT0	0x04	/* enable rx error port 0 int */
#define	SCA_IER0_MSCI_TXINT0	0x08	/* enable tx error port 0 int */
#define	SCA_IER0_MSCI_RXRDY1	0x10	/* enable rx ready port 1 int */
#define	SCA_IER0_MSCI_TXRDY1	0x20	/* enable tx ready port 1 int */
#define	SCA_IER0_MSCI_RXINT1	0x40	/* enable rx error port 1 int */
#define	SCA_IER0_MSCI_TXINT1	0x80	/* enable tx error port 1 int */

#define	SCA_IER1_DMAC_RX0A	0x01	/* enable dmac channel 0 int a */
#define	SCA_IER1_DMAC_RX0B	0x02	/* enable dmac channel 0 int b */
#define	SCA_IER1_DMAC_TX0A	0x04	/* enable dmac channel 1 int a */
#define	SCA_IER1_DMAC_TX0B	0x08	/* enable dmac channel 1 int b */
#define	SCA_IER1_DMAC_RX1A	0x10	/* enable dmac channel 2 int a */
#define	SCA_IER1_DMAC_RX1B	0x20	/* enable dmac channel 2 int b */
#define	SCA_IER1_DMAC_TX1A	0x40	/* enable dmac channel 3 int a */
#define	SCA_IER1_DMAC_TX1B	0x80	/* enable dmac channel 3 int b */

#define	SCA_IER2_TIMER_IRQ0	0x10	/* enable timer channel 0 int */
#define	SCA_IER2_TIMER_IRQ1	0x20	/* enable timer channel 1 int */
#define	SCA_IER2_TIMER_IRQ2	0x40	/* enable timer channel 2 int */
#define	SCA_IER2_TIMER_IRQ3	0x80	/* enable timer channel 3 int */

/* This is for RRC, TRC0 and TRC1. */
#define SCA_RCR_MASK            0x1F

#define SCA_IE1_

#define SCA_IV_CHAN0            0x00
#define SCA_IV_CHAN1            0x20

#define SCA_IV_RXRDY            0x04
#define SCA_IV_TXRDY            0x06
#define SCA_IV_RXINT            0x08
#define SCA_IV_TXINT            0x0A

#define SCA_IV_DMACH0           0x00
#define SCA_IV_DMACH1           0x08
#define SCA_IV_DMACH2           0x20
#define SCA_IV_DMACH3           0x28

#define SCA_IV_DMIA             0x14
#define SCA_IV_DMIB             0x16

#define SCA_IV_TIMER0           0x1C
#define SCA_IV_TIMER1           0x1E
#define SCA_IV_TIMER2           0x3C
#define SCA_IV_TIMER3           0x3E

/*
 * DMA registers
 */
#define SCA_DSR_EOT             0x80
#define SCA_DSR_EOM             0x40
#define SCA_DSR_BOF             0x20
#define SCA_DSR_COF             0x10
#define SCA_DSR_DE              0x02
#define SCA_DSR_DEWD            0x01	/* write DISABLE DE bit */

#define SCA_DMR_TMOD            0x10
#define SCA_DMR_NF              0x04
#define SCA_DMR_CNTE            0x02

#define SCA_DMER_EN             0x80

#define SCA_DCR_ABRT            0x01
#define SCA_DCR_FCCLR           0x02  /* Clear frame end intr counter */

#define SCA_DIR_EOT             0x80
#define SCA_DIR_EOM             0x40
#define SCA_DIR_BOF             0x20
#define SCA_DIR_COF             0x10

#define SCA_PCR_BRC             0x10
#define SCA_PCR_CCC             0x08
#define SCA_PCR_PR2             0x04
#define SCA_PCR_PR1             0x02
#define SCA_PCR_PR0             0x01

/*
 * Descriptor Status byte bit definitions:
 *
 *  Bit    Receive Status            Transmit Status
 * -------------------------------------------------
 *   7         EOM                       EOM
 *   6         Short Frame               ...
 *   5         Abort                     ...
 *   4         Residual bit              ...
 *   3         Overrun                   ...
 *   2         CRC                       ...
 *   1         ...                       ...
 *   0         ...                       EOT
 * -------------------------------------------------
 */

#define  ST_EOM    0x80    /* End of frame  */
#define  ST_SHRT   0x40    /* Short frame  */
#define  ST_ABT    0x20    /* Abort detected */
#define  ST_RBIT   0x10    /* Residual bit detected */
#define  ST_OVRN   0x8     /* Overrun error */
#define  ST_CRCE   0x4     /* CRC Error */
#define  ST_OVFL   0x1     /* Buffer OverFlow error  (software defined) */

#define  ST_EOT      1     /* End of transmit command */


/*  DMA  Status register (DSR)  bit definitions  */
#define  DSR_EOT  0x80      /* end of transfer EOT bit */
#define  DSR_EOM  0x40      /* end of frame EOM bit */
#define  DSR_BOF  0x20      /* buffer overflow BOF bit */
#define  DSR_COF  0x10      /* counter overflow  COF bit */
#define  DSR_DWE     1      /* write disable DWE bit */

/*  MSCI Status register 0 bits  */

#define  RXRDY_BIT  1       /* RX ready */
#define  TXRDY_BIT  2       /* TX ready */

#define ST3_CTS   8    /* modem input  /CTS bit */
#define ST3_DCD   4    /* modem input  /DCD bit */

/*
 * timer register values
 */
#define	SCA_TCSR_TME		0x10	/* timer enable */
#define	SCA_TCSR_ECMI		0x40	/* interrupt enable */
#define	SCA_TCSR_CMF		0x80	/* timer complete */

#define SCA_TEPR_DIV_1		0x00	/* 2^(n) prescale divisor */
#define SCA_TEPR_DIV_2		0x01
#define SCA_TEPR_DIV_4		0x02
#define SCA_TEPR_DIV_8		0x03
#define SCA_TEPR_DIV_16		0x04
#define SCA_TEPR_DIV_32		0x05
#define SCA_TEPR_DIV_64		0x06
#define SCA_TEPR_DIV_128	0x06


/*  TX and RX Clock Source  */
#define CLK_LINE	0x00	/* TX/RX line input */
#define CLK_BRG		0x40	/* internal baud rate generator */
#define CLK_RXC		0x60	/* receive clock */

/*   Clocking options  */
#define  CLK_INT   0        /* Internal - Baud Rate generator output */
#define  CLK_EXT   1        /* External - both clocks */
#define  CLK_RXCI  2        /* External - Receive Clock only */
#define  CLK_EETC  3        /* EETC clock:  TX = int. / RX = ext.*/

#define SCA_DMAC_OFF_0		0x00	/* offset of DMAC for port 0 */
#define SCA_DMAC_OFF_1		0x40	/* offset of DMAC for port 1 */
#define SCA_MSCI_OFF_0		0x00	/* offset of MSCI for port 0 */
#define SCA_MSCI_OFF_1		0x20	/* offset of MSCI for port 1 */

/*
 * DMA constraints
 */
#define SCA_DMA_ALIGNMENT	(64 * 1024)	/* 64 KB alignment */
#define SCA_DMA_BOUNDARY	(16 * 1024 * 1024)	/* 16 MB region */

#endif /* _DEV_IC_HD64570REG_H_ */