usart1avr.c

Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2001-2007 by egnite Software GmbH. All rights reserved.
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions
00006  * are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holders nor the names of
00014  *    contributors may be used to endorse or promote products derived
00015  *    from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00018  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00019  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00020  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00021  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00022  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00023  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00024  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00025  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00026  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00027  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00028  * SUCH DAMAGE.
00029  *
00030  * For additional information see http://www.ethernut.de/
00031  *
00032  * The 9-bit communication had been contributed by Brett Abbott,
00033  * Digital Telemetry Limited.
00034  *
00035  * Dave Smart contributed the synchronous mode support.
00036  */
00037 
00038 /*
00039  * $Log: usart1avr.c,v $
00040  * Revision 1.6  2007/08/29 07:43:53  haraldkipp
00041  * Documentation updated and corrected.
00042  *
00043  * Revision 1.5  2007/02/15 16:19:14  haraldkipp
00044  * Can use PORTG for half duplex control.
00045  *
00046  * Revision 1.4  2006/05/30 18:34:46  beutel
00047  * added #include <cfg/os.h> in compliance with usart0avr.c
00048  *
00049  * Revision 1.3  2006/02/08 15:20:06  haraldkipp
00050  * ATmega2561 Support
00051  *
00052  * Revision 1.2  2005/10/07 22:05:00  hwmaier
00053  * Using __AVR_ENHANCED__ macro instead of __AVR_ATmega128__ to support also AT90CAN128 MCU
00054  *
00055  * Revision 1.1  2005/07/26 18:02:40  haraldkipp
00056  * Moved from dev.
00057  *
00058  * Revision 1.8  2005/07/22 08:07:08  freckle
00059  * added experimental improvements to usart driver. see ChangeLog for details
00060  *
00061  * Revision 1.7  2005/01/24 22:34:49  freckle
00062  * Added new tracer by Phlipp Blum <blum@tik.ee.ethz.ch>
00063  *
00064  * Revision 1.6  2005/01/22 19:25:48  haraldkipp
00065  * Changed AVR port configuration names from PORTx to AVRPORTx.
00066  *
00067  * Revision 1.5  2004/10/22 18:04:35  freckle
00068  * added #ifdef check to support old-style CTS definition
00069  * (old style: setting CTS_SIGNAL, CTS_BIT, CTS_PORT, CTS_PIN and CTS_DDR)
00070  * instead of the new single CTS_IRQ definition
00071  *
00072  * Revision 1.4  2004/10/03 18:43:44  haraldkipp
00073  * Some drivers may require the base address set to 1
00074  *
00075  * Revision 1.3  2004/09/22 08:14:48  haraldkipp
00076  * Made configurable
00077  *
00078  * Revision 1.2  2004/05/24 20:17:15  drsung
00079  * Added function UsartSize to return number of chars in input buffer.
00080  *
00081  * Revision 1.1  2003/12/15 19:25:33  haraldkipp
00082  * New USART driver added
00083  *
00084  */
00085 
00086 #include <cfg/os.h>
00087 #include <cfg/arch/avr.h>
00088 
00089 #include <string.h>
00090 
00091 #include <sys/atom.h>
00092 #include <sys/event.h>
00093 #include <sys/timer.h>
00094 
00095 #include <dev/irqreg.h>
00096 #include <dev/usartavr.h>
00097 
00103 #ifdef UART1_RTS_BIT
00104 
00105 #if (UART1_RTS_AVRPORT == AVRPORTB)
00106 #define UART_RTS_PORT   PORTB
00107 #define UART_RTS_DDR    DDRB
00108 
00109 #elif (UART1_RTS_AVRPORT == AVRPORTD)
00110 #define UART_RTS_PORT   PORTD
00111 #define UART_RTS_DDR    DDRD
00112 
00113 #elif (UART1_RTS_AVRPORT == AVRPORTE)
00114 #define UART_RTS_PORT   PORTE
00115 #define UART_RTS_DDR    DDRE
00116 
00117 #elif (UART1_RTS_AVRPORT == AVRPORTF)
00118 #define UART_RTS_PORT   PORTF
00119 #define UART_RTS_DDR    DDRF
00120 
00121 #endif
00122 #define UART_RTS_BIT    UART1_RTS_BIT
00123 
00124 #endif /* UART1_RTS_BIT */
00125 
00131 #ifdef UART1_HDX_BIT
00132 
00133 #if (UART1_HDX_AVRPORT == AVRPORTB)
00134 #define UART_HDX_PORT   PORTB
00135 #define UART_HDX_DDR    DDRB
00136 
00137 #elif (UART1_HDX_AVRPORT == AVRPORTD)
00138 #define UART_HDX_PORT   PORTD
00139 #define UART_HDX_DDR    DDRD
00140 
00141 #elif (UART1_HDX_AVRPORT == AVRPORTE)
00142 #define UART_HDX_PORT   PORTE
00143 #define UART_HDX_DDR    DDRE
00144 
00145 #elif (UART1_HDX_AVRPORT == AVRPORTF)
00146 #define UART_HDX_PORT   PORTF
00147 #define UART_HDX_DDR    DDRF
00148 
00149 #elif (UART0_HDX_AVRPORT == AVRPORTG)
00150 #define UART_HDX_PORT  PORTG
00151 #define UART_HDX_DDR   DDRG
00152 
00153 #endif /* UART1_HDX_AVRPORT */
00154 #define UART_HDX_BIT    UART1_HDX_BIT
00155 
00156 #endif /* UART1_HDX_BIT */
00157 
00158 
00159 #ifdef __AVR_ENHANCED__
00160 
00161 /*
00162  * Local function prototypes.
00163  */
00164 static u_long AvrUsartGetSpeed(void);
00165 static int AvrUsartSetSpeed(u_long rate);
00166 static u_char AvrUsartGetDataBits(void);
00167 static int AvrUsartSetDataBits(u_char bits);
00168 static u_char AvrUsartGetParity(void);
00169 static int AvrUsartSetParity(u_char mode);
00170 static u_char AvrUsartGetStopBits(void);
00171 static int AvrUsartSetStopBits(u_char bits);
00172 static u_long AvrUsartGetFlowControl(void);
00173 static int AvrUsartSetFlowControl(u_long flags);
00174 static u_long AvrUsartGetStatus(void);
00175 static int AvrUsartSetStatus(u_long flags);
00176 static u_char AvrUsartGetClockMode(void);
00177 static int AvrUsartSetClockMode(u_char mode);
00178 static void AvrUsartTxStart(void);
00179 static void AvrUsartRxStart(void);
00180 static int AvrUsartInit(void);
00181 static int AvrUsartDeinit(void);
00182 
00187 
00191 static USARTDCB dcb_usart1 = {
00192     0,                          /* dcb_modeflags */
00193     0,                          /* dcb_statusflags */
00194     0,                          /* dcb_rtimeout */
00195     0,                          /* dcb_wtimeout */
00196     {0, 0, 0, 0, 0, 0, 0, 0},   /* dcb_tx_rbf */
00197     {0, 0, 0, 0, 0, 0, 0, 0},   /* dcb_rx_rbf */
00198     0,                          /* dbc_last_eol */
00199     AvrUsartInit,               /* dcb_init */
00200     AvrUsartDeinit,             /* dcb_deinit */
00201     AvrUsartTxStart,            /* dcb_tx_start */
00202     AvrUsartRxStart,            /* dcb_rx_start */
00203     AvrUsartSetFlowControl,     /* dcb_set_flow_control */
00204     AvrUsartGetFlowControl,     /* dcb_get_flow_control */
00205     AvrUsartSetSpeed,           /* dcb_set_speed */
00206     AvrUsartGetSpeed,           /* dcb_get_speed */
00207     AvrUsartSetDataBits,        /* dcb_set_data_bits */
00208     AvrUsartGetDataBits,        /* dcb_get_data_bits */
00209     AvrUsartSetParity,          /* dcb_set_parity */
00210     AvrUsartGetParity,          /* dcb_get_parity */
00211     AvrUsartSetStopBits,        /* dcb_set_stop_bits */
00212     AvrUsartGetStopBits,        /* dcb_get_stop_bits */
00213     AvrUsartSetStatus,          /* dcb_set_status */
00214     AvrUsartGetStatus,          /* dcb_get_status */
00215     AvrUsartSetClockMode,       /* dcb_set_clock_mode */
00216     AvrUsartGetClockMode,       /* dcb_get_clock_mode */
00217 };
00218 
00234 NUTDEVICE devUsartAvr1 = {
00235     0,                          /* Pointer to next device, dev_next. */
00236     {'u', 'a', 'r', 't', '1', 0, 0, 0, 0},    /* Unique device name, dev_name. */
00237     IFTYP_CHAR,                 /* Type of device, dev_type. */
00238     1,                          /* Base address, dev_base. */
00239     0,                          /* First interrupt number, dev_irq (not used). */
00240     0,                          /* Interface control block, dev_icb (not used). */
00241     &dcb_usart1,                /* Driver control block, dev_dcb. */
00242     UsartInit,                  /* Driver initialization routine, dev_init. */
00243     UsartIOCtl,                 /* Driver specific control function, dev_ioctl. */
00244     UsartRead,                  /* Read from device, dev_read. */
00245     UsartWrite,                 /* Write to device, dev_write. */
00246     UsartWrite_P,               /* Write data from program space to device, dev_write_P. */
00247     UsartOpen,                  /* Open a device or file, dev_open. */
00248     UsartClose,                 /* Close a device or file, dev_close. */
00249     UsartSize                   /* Request file size, dev_size. */
00250 };
00259 // added extra ifdef as test below is true even if UART1_CTS_IRQ is undef
00260 #ifdef UART1_CTS_IRQ
00261 
00262 #if (UART1_CTS_IRQ == INT0)
00263 #define UART_CTS_SIGNAL sig_INTERRUPT0
00264 #define UART_CTS_BIT    0
00265 #define UART_CTS_PORT   PORTD
00266 #define UART_CTS_PIN    PIND
00267 #define UART_CTS_DDR    DDRD
00268 
00269 #elif (UART1_CTS_IRQ == INT1)
00270 #define UART_CTS_SIGNAL sig_INTERRUPT1
00271 #define UART_CTS_BIT    1
00272 #define UART_CTS_PORT   PORTD
00273 #define UART_CTS_PIN    PIND
00274 #define UART_CTS_DDR    DDRD
00275 
00276 #elif (UART1_CTS_IRQ == INT2)
00277 #define UART_CTS_SIGNAL sig_INTERRUPT2
00278 #define UART_CTS_BIT    2
00279 #define UART_CTS_PORT   PORTD
00280 #define UART_CTS_PIN    PIND
00281 #define UART_CTS_DDR    DDRD
00282 
00283 #elif (UART1_CTS_IRQ == INT3)
00284 #define UART_CTS_SIGNAL sig_INTERRUPT3
00285 #define UART_CTS_BIT    3
00286 #define UART_CTS_PORT   PORTD
00287 #define UART_CTS_PIN    PIND
00288 #define UART_CTS_DDR    DDRD
00289 
00290 #elif (UART1_CTS_IRQ == INT4)
00291 #define UART_CTS_SIGNAL sig_INTERRUPT4
00292 #define UART_CTS_BIT    4
00293 #define UART_CTS_PORT   PORTE
00294 #define UART_CTS_PIN    PINE
00295 #define UART_CTS_DDR    DDRE
00296 
00297 #elif (UART1_CTS_IRQ == INT5)
00298 #define UART_CTS_SIGNAL sig_INTERRUPT5
00299 #define UART_CTS_BIT    5
00300 #define UART_CTS_PORT   PORTE
00301 #define UART_CTS_PIN    PINE
00302 #define UART_CTS_DDR    DDRE
00303 
00304 #elif (UART1_CTS_IRQ == INT6)
00305 #define UART_CTS_SIGNAL sig_INTERRUPT6
00306 #define UART_CTS_BIT    6
00307 #define UART_CTS_PORT   PORTE
00308 #define UART_CTS_PIN    PINE
00309 #define UART_CTS_DDR    DDRE
00310 
00311 #elif (UART1_CTS_IRQ == INT7)
00312 #define UART_CTS_SIGNAL sig_INTERRUPT7
00313 #define UART_CTS_BIT    7
00314 #define UART_CTS_PORT   PORTE
00315 #define UART_CTS_PIN    PINE
00316 #define UART_CTS_DDR    DDRE
00317 
00318 #endif
00319 
00320 #else
00321 
00322 // alternate way to specify the cts line
00323 #define UART_CTS_PORT   UART1_CTS_PORT
00324 #define UART_CTS_PIN    UART1_CTS_PIN
00325 #define UART_CTS_DDR    UART1_CTS_DDR
00326 // only set CTS_BIT if used and IRQ available
00327 #ifdef UART1_CTS_BIT
00328 #define UART_CTS_SIGNAL UART1_CTS_SIGNAL
00329 #define UART_CTS_BIT    UART1_CTS_BIT
00330 #endif
00331 
00332 #endif
00333 
00336 
00337 #define UDRn    UDR1
00338 #define UCSRnA  UCSR1A
00339 #define UCSRnB  UCSR1B
00340 #define UCSRnC  UCSR1C
00341 #define UBRRnL  UBRR1L
00342 #define UBRRnH  UBRR1H
00343 
00344 #ifdef __IMAGECRAFT__
00345 #define TXB8    TXB81
00346 #ifdef ATMega2561
00347 #define UMSEL   UMSEL01
00348 #else
00349 #define UMSEL   UMSEL1
00350 #endif
00351 #define U2X     U2X1
00352 #define UCSZ2   UCSZ12
00353 #define UCSZ1   UCSZ11
00354 #define UCSZ0   UCSZ10
00355 #define UPM0    UPM10
00356 #define UPM1    UPM11
00357 #define USBS    USBS1
00358 #define UPE     UPE1
00359 #define MPCM    MPCM1
00360 #define UCPOL   UCPOL1
00361 #endif
00362 
00363 #define sig_UART_RECV   sig_UART1_RECV
00364 #define sig_UART_DATA   sig_UART1_DATA
00365 #define sig_UART_TRANS  sig_UART1_TRANS
00366 
00367 #define SIG_UART_RECV   SIG_UART1_RECV
00368 #define SIG_UART_DATA   SIG_UART1_DATA
00369 #define SIG_UART_TRANS  SIG_UART1_TRANS
00370 
00371 #define dcb_usart   dcb_usart1
00372 
00373 #ifdef NUTTRACER
00374 #define TRACE_INT_UART_CTS TRACE_INT_UART1_CTS
00375 #define TRACE_INT_UART_RXCOMPL TRACE_INT_UART1_RXCOMPL
00376 #define TRACE_INT_UART_TXEMPTY TRACE_INT_UART1_TXEMPTY
00377 #endif
00378 
00379 #ifdef UART1_READMULTIBYTE
00380 #define UART_READMULTIBYTE
00381 #endif
00382 
00383 #ifdef USE_USART1
00384 #define USE_USART
00385 #endif
00386 
00387 #ifdef UART1_NO_SW_FLOWCONTROL
00388 #define UART_NO_SW_FLOWCONTROL
00389 #endif
00390 
00391 #include "usartavr.c"
00392 
00393 #endif

© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/