osd-contiki/cpu/avr/dev/usb/serial/uart_usb_lib.h

91 lines
2.9 KiB
C

/* This file has been prepared for Doxygen automatic documentation generation.*/
/*! \file uart_usb_lib.c *******************************************************
*
* \brief
* This file controls the UART USB functions.
*
* \addtogroup usbstick
*
* \author
* Atmel Corporation: http://www.atmel.com \n
* Support email: avr@atmel.com
*
******************************************************************************/
/* Copyright (c) 2008 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:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* 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.
* Neither the name of the copyright holders nor the names of
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 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 _UART_USB_LIB_H_
#define _UART_USB_LIB_H_
/**
\addtogroup cdctask
@{
*/
/*_____ I N C L U D E S ____________________________________________________*/
/*_____ M A C R O S ________________________________________________________*/
#ifdef UART_USB_DEFAULT_OUTPUT
#define uart_usb_putchar putchar
#endif
/*_____ D E F I N I T I O N ________________________________________________*/
typedef struct
{
U32 dwDTERate;
U8 bCharFormat;
U8 bParityType;
U8 bDataBits;
}S_line_coding;
/*_____ D E C L A R A T I O N ______________________________________________*/
void uart_usb_init(void);
bit uart_usb_tx_ready(void);
int uart_usb_putchar(int);
void uart_usb_flush(void);
bit uart_usb_test_hit(void);
char uart_usb_getchar(void);
void uart_usb_set_stdout(void);
uint8_t uart_usb_get_control_line_state(void);
void uart_usb_set_control_line_state(uint8_t control_line_state);
extern void uart_usb_configure_endpoints();
/** @} **/
#endif /* _UART_USB_LIB_H_ */