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 _AVR32_USART_H_
#define _AVR32_USART_H_

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

#define USART_OK 0

#define USART_FAILURE -1

#define USART_ERROR_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

struct usart_options_t
{
    unsigned long baudrate;

    unsigned char charlength;

    unsigned char paritytype;

    unsigned short stopbits;

    unsigned char channelmode;
};

void usart_reset(volatile struct avr32_usart_t * usart);

int usart_linit(volatile struct avr32_usart_t * usart,
        const struct usart_options_t * opt,
        const long cpuHz);

int usart_putchar(volatile struct avr32_usart_t * usart, const int character);

int usart_lwriteLine(volatile struct avr32_usart_t * usart, const char * string);

#endif /* _AVR32_USART_H_ */

---