Atmel Software Framework

usart_serial.h File Reference

Usart Serial driver for AVR UC3.

This file defines a useful set of functions for the Serial interface on AVR UC3 devices.

Copyright (c) 2009-2012 Atmel Corporation. All rights reserved.

#include "compiler.h"
#include "sysclk.h"
#include "status_codes.h"
#include "usart.h"
#include "conf_usart_serial.h"

Macros

Serial Management Configuration
#define CONFIG_USART_SERIAL_MODE   USART_NORMAL_CHMODE
 Default Usart Mode. More...
 

Typedefs

typedef volatile avr32_usart_t * usart_if
 This type can be used independently to refer to USART module for the architecture used. More...
 
typedef usart_options_t usart_serial_options_t
 

Functions

static void usart_serial_getchar (usart_if usart, uint8_t *data)
 Waits until a character is received, and returns it. More...
 
static bool usart_serial_init (volatile avr32_usart_t *usart, usart_serial_options_t *opt)
 Initializes the Usart in master mode. More...
 
static int usart_serial_putchar (usart_if usart, uint8_t c)
 Sends a character with the USART. More...
 
status_code_t usart_serial_read_packet (usart_if usart, uint8_t *data, size_t len)
 Receive a sequence of bytes to a USART device. More...
 
status_code_t usart_serial_write_packet (usart_if usart, const uint8_t *data, size_t len)
 Send a sequence of bytes to a USART device. More...
 

#define CONFIG_USART_SERIAL_MODE   USART_NORMAL_CHMODE

Default Usart Mode.

Referenced by usart_serial_init().

This type can be used independently to refer to USART module for the architecture used.

It refers to the correct type definition for the architecture, ie. USART_t* for XMEGA or avr32_usart_t* for UC3.

static void usart_serial_getchar ( usart_if  usart,
uint8_t *  data 
)
inlinestatic

Waits until a character is received, and returns it.

Parameters
usartBase address of the USART instance.
dataData to read

References usart_getchar().

Referenced by stdio_serial_init(), and usart_serial_read_packet().

static bool usart_serial_init ( volatile avr32_usart_t *  usart,
usart_serial_options_t opt 
)
inlinestatic

Initializes the Usart in master mode.

Parameters
usartBase address of the USART instance.
optOptions needed to set up RS232 communication (see usart_options_t).
Return values
trueif the initialization was successful
falseif initialization failed (error in baud rate calculation)

References usart_options_t::channelmode, CONFIG_USART_SERIAL_MODE, sysclk_enable_peripheral_clock(), sysclk_get_peripheral_bus_hz(), and usart_init_rs232().

Referenced by sio2ncp_init(), and stdio_serial_init().

static int usart_serial_putchar ( usart_if  usart,
uint8_t  c 
)
inlinestatic

Sends a character with the USART.

Parameters
usartBase address of the USART instance.
cCharacter to write.
Returns
Status.
Return values
1The character was written.
0The function timed out before the USART transmitter became ready to send.

References USART_SUCCESS, and usart_write_char().

Referenced by stdio_serial_init(), and usart_serial_write_packet().

status_code_t usart_serial_read_packet ( usart_if  usart,
uint8_t *  data,
size_t  len 
)

Receive a sequence of bytes to a USART device.

Parameters
usartBase address of the USART instance.
datadata buffer to write
lenLength of data

Receive a sequence of bytes to a USART device.

Parameters
usartBase address of the USART instance.
dataData buffer to write
lenLength of data

References STATUS_OK, and usart_serial_getchar().

status_code_t usart_serial_write_packet ( usart_if  usart,
const uint8_t *  data,
size_t  len 
)

Send a sequence of bytes to a USART device.

Parameters
usartBase address of the USART instance.
datadata buffer to write
lenLength of data

Send a sequence of bytes to a USART device.

Parameters
usartBase address of the USART instance.
dataData buffer to read
lenLength of data

References STATUS_OK, and usart_serial_putchar().

Referenced by sio2host_tx(), and sio2ncp_tx().