1 /**
2  * \file
3  *
4  * \brief SAM USB Dual Role driver header file.
5  *
6  * Copyright (c) 2014-2015 Atmel Corporation. All rights reserved.
7  *
8  * \asf_license_start
9  *
10  * \page License
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  *    this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright notice,
19  *    this list of conditions and the following disclaimer in the documentation
20  *    and/or other materials provided with the distribution.
21  *
22  * 3. The name of Atmel may not be used to endorse or promote products derived
23  *    from this software without specific prior written permission.
24  *
25  * 4. This software may only be redistributed and used in connection with an
26  *    Atmel microcontroller product.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  *
40  * \asf_license_stop
41  *
42  */
43 /*
44  * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
45  */
46 
47 #ifndef _USB_DUAL_H_
48 #define _USB_DUAL_H_
49 
50 #include "compiler.h"
51 #include "preprocessor.h"
52 
53 /* Get USB pads pins configuration in board configuration */
54 #include "conf_board.h"
55 #include "board.h"
56 #include "extint.h"
57 #include "port.h"
58 
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62 
63 /**
64  * \ingroup usb_group
65  * \defgroup usb_dual_group USB dual role driver
66  * USB low-level driver for dual role features
67  *
68  * @{
69  */
70 
71 bool usb_dual_enable(void);
72 void usb_dual_disable(void);
73 
74 /**
75  * @name USB ID pin management
76  *
77  * The ID pin come from the USB connector (A and B receptable) and
78  * allows to select the USB mode between host or device.
79  * The ID pin can be managed through EIC pin.
80  * This feature is optional, and it is enabled if USB_ID_PIN
81  * is defined in board.h and CONF_BOARD_USB_ID_DETECT defined in
82  * conf_board.h.
83 *
84 * @{
85 */
86 #define USB_ID_DETECT        (defined(CONF_BOARD_USB_ID_DETECT))
87 #define USB_ID_EIC           (defined(USB_ID_PIN) && USB_ID_DETECT)
88 /** @} */
89 
90 /**
91  * @name USB Vbus management
92  *
93  * The VBus line can be monitored through a EIC pin and
94  * a basic resistor voltage divider.
95  * This feature is optional, and it is enabled if USB_VBUS_PIN
96  * is defined in board.h and CONF_BOARD_USB_VBUS_DETECT defined in
97  * conf_board.h.
98  *
99  * @{
100  */
101 #define USB_VBUS_DETECT      (defined(CONF_BOARD_USB_VBUS_DETECT))
102 #define USB_VBUS_EIC         (defined(USB_VBUS_PIN) && USB_VBUS_DETECT)
103 /** @} */
104 
105 /** @} */
106 
107 #ifdef __cplusplus
108 }
109 #endif
110 
111 #endif // _USB_DUAL_H_
112