10d163575Sopenharmony_ci/*
2 * Copyright (c) 2013-2019, Huawei Technologies Co., Ltd. All rights reserved.
3 * Copyright (c) 2020, Huawei Device Co., Ltd. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this list of
9 *    conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 *    of conditions and the following disclaimer in the documentation and/or other materials
13 *    provided with the distribution.
14 *
15 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
16 *    to endorse or promote products derived from this software without specific prior written
17 *    permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef __USB_INIT_H__
33#define	 __USB_INIT_H__
34
35#include <los_memory.h>
36
37#include "implementation/global_implementation.h"
38#include "usb_process.h"
39
40#ifdef __cplusplus
41#if __cplusplus
42extern "C" {
43#endif /* __cplusplus */
44#endif /* __cplusplus */
45
46/* Controller type */
47typedef enum controller_type {
48	HOST = 0,
49	DEVICE
50} controller_type;
51
52/* device type */
53typedef enum device_type {
54	DEV_SERIAL = 1,	/* used for serial */
55	DEV_ETHERNET,	/* used for rndis */
56	DEV_SER_ETH,	/* used for serial and rndis */
57	DEV_DFU,		/* used for DFU */
58	DEV_MASS,		/* used for mass */
59	DEV_UVC,		/* used for USB video */
60	DEV_UAC,		/* used for USB audio */
61	DEV_CAMERA,		/* used for USB camera */
62	DEV_HID,		/* used for USB hid */
63	DEV_GENERIC,	/* used for USB generic */
64} device_type;
65
66/*
67 * Function:usb_init
68 * Description: initialize the controller of usb, attach the usb protocol.
69 * Input: ctype ------ the type of usb's controller, the legal value is one of 'controller_type';
70 * 					if it is HOST , 'dtype' can be any value of 'device_type';
71 * 					if it is DEVICE, 'dtype' must be one of 'device_type' that user needs.
72 *		  dtype ------ the type of device, the legal value is one of 'device_type';
73 * 					if 'ctype' is DEVICE, it is determined by the use requirements.
74 * Output: None
75 * Return: success is LOS_OK, failure is LOS_NOK.
76 */
77uint32_t usb_init(controller_type ctype, device_type dtype);
78
79/*
80 * Function:usb_deinit
81 * Description: uninitialize the controller of usb, dettach the usb protocol.
82 * Input: None
83 * Output: None
84 * Return: success is LOS_OK, failure is LOS_NOK.
85 */
86uint32_t usb_deinit(void);
87
88/*
89 * Function:usb_is_devicemode
90 * Description: check usb device mode.
91 * Input: None
92 * Output: None
93 * Return: true is usb device mode, false is not linked or not usb device mode.
94 */
95bool usb_is_devicemode(void);
96
97#ifdef __cplusplus
98#if __cplusplus
99}
100#endif /* __cplusplus */
101#endif /* __cplusplus */
102
103#endif
104