summaryrefslogtreecommitdiff
path: root/tinyusb/host/usbh.h
blob: 2934e4c3c3be65bd1ae7bee48a919e6dee24ef0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 * usbh.h
 *
 *  Created on: Jan 19, 2013
 *      Author: hathach
 */

/*
 * Software License Agreement (BSD License)
 * Copyright (c) 2013, hathach (tinyusb.net)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 *
 * This file is part of the tiny usb stack.
 */

/** \file
 *  \brief TBD
 *
 *  \note TBD
 */

/** \ingroup TBD
 *  \defgroup TBD
 *  \brief TBD
 *
 *  @{
 */

#ifndef _TUSB_USBD_HOST_H_
#define _TUSB_USBD_HOST_H_

#ifdef __cplusplus
 extern "C" {
#endif

//--------------------------------------------------------------------+
// INCLUDE
//--------------------------------------------------------------------+
#include "hcd.h"

//--------------------------------------------------------------------+
// MACRO CONSTANT TYPEDEF
//--------------------------------------------------------------------+
#define CLASS_TABLE(ENTRY_EXPANDER) \
    ENTRY_EXPANDER(TUSB_CLASS_AUDIO)\
    ENTRY_EXPANDER(TUSB_CLASS_CDC)\
    ENTRY_EXPANDER(TUSB_CLASS_HID)\
    ENTRY_EXPANDER(TUSB_CLASS_PHYSICAL)\
    ENTRY_EXPANDER(TUSB_CLASS_IMAGE)\
    ENTRY_EXPANDER(TUSB_CLASS_PRINTER)\
    ENTRY_EXPANDER(TUSB_CLASS_MSC)\
    ENTRY_EXPANDER(TUSB_CLASS_HUB)\
    ENTRY_EXPANDER(TUSB_CLASS_CDC_DATA)\
    ENTRY_EXPANDER(TUSB_CLASS_SMART_CARD)\
    ENTRY_EXPANDER(TUSB_CLASS_CONTENT_SECURITY)\
    ENTRY_EXPANDER(TUSB_CLASS_VIDEO)\
    ENTRY_EXPANDER(TUSB_CLASS_PERSONAL_HEALTHCARE)\
    ENTRY_EXPANDER(TUSB_CLASS_AUDIO_VIDEO)\

#define CLASS_LOOKUP_EXPAND(class_code)

#define CLASS_LOOKUP_INIT_FUNCTION(class_code)\

#define CLASS_EXPANDER_INIT(class_code)\



//  TUSB_CLASS_DIAGNOSTIC           = 0xDC ,
//  TUSB_CLASS_WIRELESS_CONTROLLER  = 0xE0 ,
//  TUSB_CLASS_MISC                 = 0xEF ,
//  TUSB_CLASS_APPLICATION_SPECIFIC = 0xEF ,
//  TUSB_CLASS_VENDOR_SPECIFIC      = 0xFF

typedef enum pipe_status_{
  PIPE_STATUS_READY = 0,
  PIPE_STATUS_BUSY,
  PIPE_STATUS_COMPLETE,
  PIPE_STATUS_ERROR
} pipe_status_t;

typedef uint32_t tusbh_flag_class_t;
typedef uint32_t tusb_handle_device_t;
typedef uint8_t  tusbh_device_status_t;

typedef struct {
  void (* const init) (void);
  tusb_error_t (* const open_subtask)(uint8_t, uint8_t const *, uint16_t*);
  void (* const isr) (pipe_handle_t, tusb_bus_event_t);
  void (* const close) (uint8_t);
} host_class_driver_t;
//--------------------------------------------------------------------+
// INTERNAL OBJECT & FUNCTION DECLARATION
//--------------------------------------------------------------------+

//--------------------------------------------------------------------+
// APPLICATION API
//--------------------------------------------------------------------+
uint8_t      tusbh_device_attached_cb (tusb_descriptor_device_t const *p_desc_device) ATTR_WEAK ATTR_WARN_UNUSED_RESULT;
void         tusbh_device_mount_succeed_cb (tusb_handle_device_t device_hdl) ATTR_WEAK;
void         tusbh_device_mount_failed_cb(tusb_error_t error, tusb_descriptor_device_t const *p_desc_device) ATTR_WEAK; // TODO refractor remove desc_device

tusb_error_t tusbh_configuration_set     (tusb_handle_device_t device_hdl, uint8_t configure_number) ATTR_WARN_UNUSED_RESULT;
tusbh_device_status_t tusbh_device_status_get (tusb_handle_device_t const device_hdl) ATTR_WARN_UNUSED_RESULT;

#if TUSB_CFG_OS == TUSB_OS_NONE // TODO move later
//static inline void tusb_tick_tock(void) ATTR_ALWAYS_INLINE;
//static inline void tusb_tick_tock(void)
//{
//  osal_tick_tock();
//}
#endif

//--------------------------------------------------------------------+
// CLASS-USBD API
//--------------------------------------------------------------------+
#ifdef _TINY_USB_SOURCE_FILE_

tusb_error_t usbh_init(void);
pipe_status_t usbh_pipe_status_get(pipe_handle_t pipe_hdl) ATTR_WARN_UNUSED_RESULT;

#endif

#ifdef __cplusplus
 }
#endif

#endif /* _TUSB_USBD_HOST_H_ */

/** @} */