Home | History | Annotate | Line # | Download | only in at91
at91usartreg.h revision 1.2
      1 /*	$NetBSD: at91usartreg.h,v 1.2 2008/07/03 01:15:39 matt Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2007 Embedtronics Oy. All rights reserved.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions
      8  * are met:
      9  * 1. Redistributions of source code must retain the above copyright
     10  *    notice, this list of conditions and the following disclaimer.
     11  * 2. Redistributions in binary form must reproduce the above copyright
     12  *    notice, this list of conditions and the following disclaimer in the
     13  *    documentation and/or other materials provided with the distribution.
     14  * 3. All advertising materials mentioning features or use of this software
     15  *    must display the following acknowledgement:
     16  *	This product includes software developed by Ichiro FUKUHARA.
     17  * 4. The name of the company nor the name of the author may be used to
     18  *    endorse or promote products derived from this software without specific
     19  *    prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY ICHIRO FUKUHARA ``AS IS'' AND ANY EXPRESS OR
     22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     24  * IN NO EVENT SHALL ICHIRO FUKUHARA OR THE VOICES IN HIS HEAD BE LIABLE FOR
     25  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     31  * SUCH DAMAGE.
     32  */
     33 
     34 #ifndef _AT91USARTREG_H_
     35 #define _AT91USARTREG_H_
     36 
     37 #define	US_CR		0x00U	/* 0x00: Control Register	*/
     38 #define	US_MR		0x04U	/* 0x04: Mode Register		*/
     39 #define	US_IER		0x08U	/* 0x08: Interrupt Enable Reg	*/
     40 #define	US_IDR		0x0CU	/* 0x0C: Interrupt Disable Reg	*/
     41 #define	US_IMR		0x10U	/* 0x10: Interrupt Mask Reg	*/
     42 #define	US_CSR		0x14U	/* 0x14: Channel Status Reg	*/
     43 #define	US_RHR		0x18U	/* 0x18: Receive Holding Reg	*/
     44 #define	US_THR		0x1CU	/* 0x1C: Transmit Holding Reg	*/
     45 #define	US_BRGR		0x20U	/* 0x20: Baud Rate Generator Rg	*/
     46 #define	US_RTOR		0x24U	/* 0x24: Receiver Time-out Reg	*/
     47 #define	US_TTGR		0x28U	/* 0x28: Transmitter Timeguard Reg */
     48 #define	US_FIDI		0x40U	/* 0x40: FI DI Ratio Register	*/
     49 #define	US_NER		0x44U	/* 0x44: Number of Errorrs Reg	*/
     50 #define	US_IF		0x4CU	/* 0x4C: IrDA Filter Register	*/
     51 #define	US_PDC		0x100U	/* 0x100: PDC			*/
     52 
     53 /* Control Register bits: */
     54 #define	US_CR_RTSDIS	0x00080000U	/* 1 = disable RTS		*/
     55 #define	US_CR_RTSEN	0x00040000U	/* 1 = enable RTS		*/
     56 #define	US_CR_DTRDIS	0x00020000U	/* 1 = disable DTR		*/
     57 #define	US_CR_DTREN	0x00010000U	/* 1 = enable DTR		*/
     58 #define	US_CR_RETTO	0x00008000U	/* 1 = Rearm Time-out		*/
     59 #define	US_CR_RSTNACK	0x00004000U	/* 1 = Reset Non Acknowledge	*/
     60 #define	US_CR_RSTIT	0x00002000U	/* 1 = Reset Iterations		*/
     61 #define	US_CR_SENDA	0x00001000U	/* 1 = Send Address		*/
     62 #define	US_CR_STTTO	0x00000800U	/* 1 = Start Time-out		*/
     63 #define	US_CR_STPBRK	0x00000400U	/* 1 = stop break		*/
     64 #define	US_CR_STTBRK	0x00000200U	/* 1 = start break		*/
     65 #define	US_CR_RSTSTA	0x00000100U	/* 1 = reset status bits	*/
     66 #define	US_CR_TXDIS	0x00000080U	/* 1 = disable transmitter	*/
     67 #define	US_CR_TXEN	0x00000040U	/* 1 = enable transmitter	*/
     68 #define	US_CR_RXDIS	0x00000020U	/* 1 = disable receiver		*/
     69 #define	US_CR_RXEN	0x00000010U	/* 1 = enable receiver		*/
     70 #define	US_CR_RSTTX	0x00000008U	/* 1 = reset transmitter	*/
     71 #define	US_CR_RSTRX	0x00000004U	/* 1 = reset receiver		*/
     72 
     73 /* Mode Register: */
     74 #define	US_MR_FILTER	0x10000000U	/* 1 = Infrared Receive filter	*/
     75 #define	US_MR_MAX_ITER 0x07000000U	/* maximum number of iterations in ISO7816 */
     76 #define	US_MR_MAX_ITER_SHIFT 24
     77 #define	US_MR_DSNACK	0x00200000U	/* 1 = disable successive NACK	*/
     78 #define	US_MR_INACK	0x00100000U	/* 1 = the NACK is not generated*/
     79 #define	US_MR_OVER	0x00080000U	/* 1 = 8x oversampling (0 = 16x	*/
     80 #define	US_MR_CLKO	0x00040000U	/* 1 = drive SCK		*/
     81 #define	US_MR_MODE9	0x00020000U	/* 9-bit character length	*/
     82 #define	US_MR_MSBF	0x00010000U	/* 1 = send MSB first		*/
     83 
     84 #define	US_MR_CHMODE	0x0000C000U	/* channel mode			*/
     85 #define	US_MR_CHMODE_SHIFT	14U
     86 #define	US_MR_CHMODE_NORMAL	0x00000000U
     87 #define	US_MR_CHMODE_ECHO	0x00004000U
     88 #define	US_MR_CHMODE_LOCAL_LOOP	0x00008000U
     89 #define	US_MR_CHMODE_REMOTE_LOOP 0x0000C000U
     90 
     91 #define	US_MR_NBSTOP		0x00003000U /* number of stop bits	*/
     92 #define	US_MR_NBSTOP_SHIFT	12U
     93 #define	US_MR_NBSTOP_1		0x00000000U
     94 #define	US_MR_NBSTOP_1_5	0x00001000U
     95 #define	US_MR_NBSTOP_2		0x00002000U
     96 
     97 #define	US_MR_PAR		0x00000E00U /* parity type		*/
     98 #define	US_MR_PAR_SHIFT		9U
     99 #define	US_MR_PAR_EVEN		0x00000000U
    100 #define	US_MR_PAR_ODD		0x00000200U
    101 #define	US_MR_PAR_SPACE		0x00000400U
    102 #define	US_MR_PAR_MARK		0x00000600U
    103 #define	US_MR_PAR_NONE		0x00000800U
    104 #define	US_MR_PAR_MULTI_DROP	0x00000C00U
    105 
    106 #define	US_MR_SYNC		0x00000100U /* 1 = synchronous mode	*/
    107 
    108 #define	US_MR_CHRL	   	0x000000C0U /* character length		*/
    109 #define	US_MR_CHRL_SHIFT   	6U
    110 #define	US_MR_CHRL_5		0x00000000U
    111 #define	US_MR_CHRL_6		0x00000040U
    112 #define	US_MR_CHRL_7		0x00000080U
    113 #define	US_MR_CHRL_8		0x000000C0U
    114 
    115 #define	US_MR_USCLKS 	0x00000030U /* clock selection		*/
    116 #define	US_MR_USCLKS_SHIFT	4U
    117 #define	US_MR_USCLKS_MCK	0x00000000U
    118 #define	US_MR_USCLKS_MCK_DIV	0x00000010U
    119 #define	US_MR_USCLKS_SCK	0x00000030U
    120 
    121 #define	US_MR_MODE		0x0000000FU
    122 #define	US_MR_MODE_SHIFT	0U
    123 #define	US_MR_MODE_NORMAL	0x00000000U
    124 #define	US_MR_MODE_RS485	0x00000001U
    125 #define	US_MR_MODE_AUTO_RTSCTS	0x00000002U
    126 #define	US_MR_MODE_MODEM	0x00000003U
    127 #define	US_MR_MODE_ISO7816_T0	0x00000004U
    128 #define	US_MR_MODE_ISO7816_T1	0x00000006U
    129 #define	US_MR_MODE_IRDA		0x00000008U
    130 
    131 
    132 /* Interrupt bits: */
    133 #define	US_CSR_CTSIC		0x00080000U
    134 #define	US_CSR_DCDIC		0x00040000U
    135 #define	US_CSR_DSRIC		0x00020000U
    136 #define	US_CSR_RIIC		0x00010000U
    137 #define	US_CSR_NACK		0x00002000U
    138 #define	US_CSR_RXBUFF		0x00001000U
    139 #define	US_CSR_TXBUFE		0x00000800U
    140 #define	US_CSR_ITERATION	0x00000400U
    141 #define	US_CSR_TXEMPTY		0x00000200U
    142 #define	US_CSR_TIMEOUT		0x00000100U
    143 #define	US_CSR_PARE		0x00000080U
    144 #define	US_CSR_FRAME		0x00000040U
    145 #define	US_CSR_OVRE		0x00000020U
    146 #define	US_CSR_ENDTX		0x00000010U
    147 #define	US_CSR_ENDRX		0x00000008U
    148 #define	US_CSR_RXBRK		0x00000004U
    149 #define	US_CSR_TXRDY		0x00000002U
    150 #define	US_CSR_RXRDY		0x00000001U
    151 
    152 /* Channel Status Register bits (int bits + bits below): */
    153 #define	US_CSR_CTS		0x00800000U
    154 #define	US_CSR_DCD		0x00400000U
    155 #define	US_CSR_DSR		0x00200000U
    156 #define	US_CSR_RI		0x00100000U
    157 
    158 
    159 #define	USART_INIT(sc, speed) do {					\
    160   at91usart_writereg(sc, US_PDC + PDC_PTCR,				\
    161 		      PDC_PTCR_TXTDIS | PDC_PTCR_RXTDIS);		\
    162   at91usart_writereg(sc, US_PDC + PDC_RNCR, 0);				\
    163   at91usart_writereg(sc, US_PDC + PDC_RCR, 0);				\
    164   at91usart_writereg(sc, US_PDC + PDC_TNCR, 0);				\
    165   at91usart_writereg(sc, US_PDC + PDC_TCR, 0);				\
    166   at91usart_writereg(sc, US_MR, US_MR_USCLKS_MCK | US_MR_CHRL_8		\
    167 		      | US_MR_PAR_NONE | US_MR_NBSTOP_1);		\
    168   at91usart_writereg(sc, US_BRGR,					\
    169 		      (AT91_MSTCLK / 16 + (speed) / 2) / (speed));	\
    170   at91usart_writereg(sc, US_CR, US_CR_RSTRX | US_CR_RSTTX);		\
    171   at91usart_writereg(sc, US_CR, US_CR_RSTSTA | US_CR_RXEN | US_CR_TXEN	\
    172 		      | US_CR_STPBRK);					\
    173   (void)at91usart_readreg(sc, US_CSR);					\
    174 } while (/*CONSTCOND*/0)
    175 
    176 #if 0
    177 #define	USART_PUTC(sc, ch) do {						\
    178   while ((USARTREG(USART_SR) & USART_SR_TXRDY) == 0) ;			\
    179   USARTREG(USART_THR) = ch;						\
    180 } while (/*CONSTCOND*/0)
    181 
    182 #define	USART_PEEKC() ((USARTREG(USART_SR) & USART_SR_RXRDY) ? USARTREG(USART_RHR) : -1)
    183 
    184 #define	USART_PUTS(string) do {						\
    185   const char *_ptr = (string);						\
    186   while (*_ptr) {							\
    187     USART_PUTC(*_ptr);							\
    188     _ptr++;								\
    189   }									\
    190 } while (/*CONSTCOND*/0)
    191 #endif
    192 
    193 #endif	// _AT91USARTREG_H_
    194 
    195