usart.h

Go to the documentation of this file.

/*This file has been prepared for Doxygen automatic documentation generation.*/
/* *****************************************************************************
Copyright (c) 2006, Atmel Corporation 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. The name of ATMEL may not be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ATMEL ``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 EXPRESSLY AND SPECIFICALLY
DISCLAIMED. IN NO EVENT SHALL ATMEL 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.

************************************************************************ */


#ifndef _USART_H_
#define _USART_H_

#ifdef __GNUC__
        #include <avr32/io.h>
#elif __ICCAVR32__
        #include <avr32/ioap7000.h>
#else
        #error No known compiler used
#endif


struct usart_options_t
{
        unsigned long baudrate;

        unsigned char charlength;

        unsigned char paritytype;

        unsigned short stopbits;

        unsigned char channelmode;
};


struct iso7816_options_t
{
        /*
         * Set the frequency of the ISO7816 clock
         */
        unsigned long iso7816_hz;

        /*
         * The number of ISO7816 clock tick in every bit period (1-2047, 0=disable clock)
         * Bit rate = iso7816_hz / fidi_ratio
         */
        unsigned short fidi_ratio;

        /*
         * Inhibit Non Acknowledge
         * - 0 - The NACK is generated
         * - 1 - The NACK is not generated
         * .
         * Note: This bit will be used only in ISO7816 mode, protocol T = 0 receiver
         */
        int inhibit_nack;

        /*
         * Disable Successive NACK \n\n
         * Successive parity errors are counted up to the value in the max_iterations field. \n
         * These parity errors generate a NACK on the ISO line. As soon as this value is reached, \n
         * no addititional NACK is sent on the ISO line. The flag ITERATION is asserted. \n
         */
        int dis_suc_nack;

        /*
         * Max number of repetitions (0 - 7)
         */
        unsigned char max_iterations;

        /*
         * Bitorder in transmitted characters
         * - 0 - LSB first
         * - 1 - MSB first
         */
        int bit_order;
};

 /*---------------------------------------------------------------------------+
 |                                                                                                |
 |                           INITIALIZATION FUNCTIONS                |
 |                                                                                                |
 +---------------------------------------------------------------------------*/

void usart_reset( volatile struct avr32_usart_t * usart );


int usart_init_rs232( volatile struct avr32_usart_t * usart, struct usart_options_t * opt, long cpu_hz );


 /*---------------------------------------------------------------------------+
 |                                                                                                |
 |                         TRANSMIT/RECEIVE FUNCTIONS         |
 |                                                                                                |
 +---------------------------------------------------------------------------*/

int usart_send_addr(volatile struct avr32_usart_t * usart, int addr);


int usart_write_char(volatile struct avr32_usart_t * usart, int c);


inline void usart_bw_write_char(volatile struct avr32_usart_t * usart, int c);

int usart_putchar(volatile struct avr32_usart_t * usart, int c);

int usart_read_char(volatile struct avr32_usart_t * usart, int * c);

int usart_getchar(volatile struct avr32_usart_t * usart);

void usart_reset_status(volatile struct avr32_usart_t * usart);

#define USART_SUCCESS 0

#define USART_FAILURE -1

#define USART_INVALID_INPUT 1
#define USART_INVALID_ARGUMENT -1

#define USART_TX_BUSY  2

#define USART_RX_EMPTY 3

#define USART_RX_ERROR 4

#define USART_MODE_FAULT 5

#define USART_ADDR_RECEIVED 1

#define USART_DEFAULT_TIMEOUT  10000

#define USART_EVEN_PARITY       0

#define USART_ODD_PARITY        1

#define USART_SPACE_PARITY      2

#define USART_MARK_PARITY       3

#define USART_NO_PARITY         4

#define USART_MULTIDROP_PARITY  6

#define USART_MODE_NORMAL       0x00

#define USART_MODE_RS485        0x01

#define USART_MODE_HW_HSH       0x02

#define USART_MODE_MODEM        0x03

#define USART_MODE_ISO7816_T0   0x04

#define USART_MODE_ISO7816_T1   0x06

#define USART_MODE_IRDA         0x08

#define USART_MODE_SW_HSH       0x0C

#define USART_NORMAL_CHMODE     0

#define USART_AUTO_ECHO         1

#define USART_LOCAL_LOOPBACK    2

#define USART_REMOTE_LOOPBACK   3

#define USART_1_STOPBIT         0

#define USART_1_5_STOPBITS      1

#define USART_2_STOPBITS        2

/*
        Interrupt sources. Use with interrupt registers in USART
*/

#define INT_RXRDY      0
#define INT_TXRDY      1
#define INT_RXBRK      2
#define INT_ENDRX      3
#define INT_ENDTX      4
#define INT_OVRE       5
#define INT_FRAM       6
#define INT_PARE       7
#define INT_TIMEOUT    8
#define INT_TXEMPTY    9
#define INT_ITERATION 10
#define INT_TXBUFE    11
#define INT_RXBUFF    12
#define INT_NACK      13
#define INT_RIIC      16
#define INT_DSRIC     17
#define INT_DCDIC     18
#define INT_CTSIC     19
#define INT_MANE      20

#endif //#ifndef _AVR32_USART_H_

---