MAV'RIC
usb_int.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 usb_int.h
34  *
35  * \author MAV'RIC Team
36  * \author Geraud L'Eplattenier
37  *
38  * \brief This file implements the USB communication protocol
39  *
40  ******************************************************************************/
41 
42 #ifndef USB_INT_H_
43 #define USB_INT_H_
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #include <stdint.h>
50 #include "stdio_usb.h"
51 #include "udi_cdc.h"
52 #include "streams.h"
53 #include "uart_int.h"
54 
58 typedef struct
59 {
60  int32_t IRQ;
61  //Buffer_t transmit_buffer; ///< Transmission buffer
62  //Buffer_t receive_buffer; ///< Reception buffer
65 
69 typedef struct
70 {
71  int32_t mode;
73 } usb_config_t;
74 
78 enum USB_MODE
79 {
80  USB_OFF,
81  USB_IN,
82  USB_OUT,
83  USB_IN_OUT
84 };
85 
89 enum AVAILABLE_USB
90 {
91  USB = -1
92 };
93 
99 void usb_int_set_usb_conf(usb_config_t* usb_config);
100 
101 
105 void usb_int_init(void);
106 
107 
113 usb_config_t *usb_int_get_usb_handle(void);
114 
115 
123 //int8_t uart_int_get_byte(usart_config_t *usart_conf);
124 
132 //int32_t uart_int_bytes_available(usart_config_t *usart_conf);
133 
140 void usb_int_send_byte(usb_config_t *usb_conf, uint8_t data) ;
141 
142 
148 //void uart_int_flush(usart_config_t *usart_conf );
149 
156 void usb_int_register_write_stream(usb_config_t *usb_conf, byte_stream_t *stream);
157 
166 //void uart_int_register_write_stream_nonblocking(usart_config_t *usart_conf, byte_stream_t *stream);
167 
174 void usb_int_register_read_stream(usb_config_t *usb_conf, byte_stream_t *stream);
175 
176 #ifdef __cplusplus
177 }
178 #endif
179 
180 #endif /* USB_INT_H_ */
USB interface structure.
Definition: usb_int.h:58
USB configuration interface structure.
Definition: usb_int.h:69
usb_interface_t usb_device
Define which device to configure.
Definition: usb_int.h:72
byte_stream_t * receive_stream
Pointer to the reception stream.
Definition: usb_int.h:63
int32_t IRQ
IRQ of the USB interface.
Definition: usb_int.h:60
Byte stream.
Definition: streams.h:62
int32_t mode
Define the mode to use.
Definition: usb_int.h:71