MAV'RIC
console.h
1 /*******************************************************************************
2  * Copyright (c) 2009-2014, MAV'RIC Development Team
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  ******************************************************************************/
31 
32 /*******************************************************************************
33  * \file console.h
34  *
35  * \author MAV'RIC Team
36  * \author Gregoire Heitz
37  * \author Geraud L'Eplattenier
38  *
39  * \brief This file configures the console UART communication
40  *
41  ******************************************************************************/
42 
43 
44 #ifndef CONSOLE_H_
45 #define CONSOLE_H_
46 
47 #include "streams.h"
48 #include "buffer.h"
49 #include "uart_int.h"
50 #include "usb_int.h"
51 
52 typedef enum
53 {
54  CONSOLE_UART0 = UART0,
55  CONSOLE_UART1 = UART1,
56  CONSOLE_UART2 = UART2,
57  CONSOLE_UART3 = UART3,
58  CONSOLE_UART4 = UART4,
59  CONSOLE_USB = USB
60 }console_port_t;
61 
69 void console_init(console_port_t console_port, usart_config_t usart_conf_console, usb_config_t usb_conf_console);
70 
76 byte_stream_t* console_get_in_stream(void);
77 
83 byte_stream_t* console_get_out_stream(void);
84 
85 #endif /* CONSOLE_H_ */
USB configuration interface structure.
Definition: usb_int.h:69
Byte stream.
Definition: streams.h:62
UART configuration structure.
Definition: uart_int.h:80