ald_usb.h 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821
  1. /**
  2. *********************************************************************************
  3. *
  4. * @file ald_usb.h
  5. * @brief Header file of USB module driver.
  6. *
  7. * @version V1.0
  8. * @date 25 Feb. 2022
  9. * @author AE Team
  10. * @note
  11. * Change Logs:
  12. * Date Author Notes
  13. * 25 Feb. 2022 AE Team The first version
  14. *
  15. * Copyright (C) Shanghai Eastsoft Microelectronics Co. Ltd. All rights reserved.
  16. *
  17. * SPDX-License-Identifier: Apache-2.0
  18. *
  19. * Licensed under the Apache License, Version 2.0 (the License); you may
  20. * not use this file except in compliance with the License.
  21. * You may obtain a copy of the License at
  22. *
  23. * www.apache.org/licenses/LICENSE-2.0
  24. *
  25. * Unless required by applicable law or agreed to in writing, software
  26. * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  27. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  28. * See the License for the specific language governing permissions and
  29. * limitations under the License.
  30. **********************************************************************************
  31. */
  32. #ifndef __ALD_USB_H__
  33. #define __ALD_USB_H__
  34. #ifdef __cplusplus
  35. extern "C" {
  36. #endif /* __cplusplus */
  37. #include <stdbool.h>
  38. #include "ald_utils.h"
  39. #include "ald_dma.h"
  40. /** @addtogroup ES32VF2264_ALD
  41. * @{
  42. */
  43. /** @addtogroup USB
  44. * @{
  45. */
  46. /** @defgroup USB_Public_Macros USB Public Macros
  47. * @{
  48. */
  49. /* Power */
  50. #define ALD_USB_POWER_RESET 0x00000008U
  51. #define ALD_USB_POWER_RESUME 0x00000004U
  52. #define ALD_USB_POWER_SUSPEND 0x00000002U
  53. #define ALD_USB_POWER_ISOUDT 0x00000080U
  54. #define ALD_USB_POWER_SUSPENDEN 0x00000001U
  55. /* DPDMCON */
  56. #define ALD_USB_DPDMCON_DPPUD 0x00000018U
  57. #define ALD_USB_DPDMCON_DPPUD_FLOAT 0x00000000U
  58. #define ALD_USB_DPDMCON_DPPUD_UP 0x00000008U
  59. #define ALD_USB_DPDMCON_DPPUD_DOWN 0x00000010U
  60. #define ALD_USB_DPDMCON_DMPUD 0x00000006U
  61. #define ALD_USB_DPDMCON_DMPUD_FLOAT 0x00000000U
  62. #define ALD_USB_DPDMCON_DMPUD_UP 0x00000002U
  63. #define ALD_USB_DPDMCON_DMPUD_DOWN 0x00000004U
  64. #define ALD_USB_DPDMCON_PHYPWREN 0x00000001U
  65. /* SWCID */
  66. #define ALD_USB_SWCID_HOST 0x00000002U
  67. #define ALD_USB_SWCID_CIDCTRL 0x00000001U
  68. /* SWVBUS */
  69. #define ALD_USB_SWVBUS_VALTH 0x00000008U
  70. #define ALD_USB_SWVBUS_SESVALTH 0x00000004U
  71. #define ALD_USB_SWVBUS_SESENDTH 0x00000002U
  72. #define ALD_USB_SWVBUS_SIGCTRL 0x00000001U
  73. /* SWTMODE */
  74. #define ALD_USB_SWTMODE_EN 0x00000001U
  75. /* DEVCON */
  76. #define ALD_USB_DEVCON_FSDEV 0x00000040U
  77. #define ALD_USB_DEVCON_LSDEV 0x00000020U
  78. #define ALD_USB_DEVCON_HOST 0x00000004U
  79. #define ALD_USB_DEVCON_HOSTREQ 0x00000002U
  80. #define ALD_USB_DEVCON_SESSION 0x00000001U
  81. /* CSR0L_TXCSRL */
  82. #define ALD_USB_CSR0L_NAKTO 0x00000080U
  83. #define ALD_USB_CSR0L_STATUSPKT 0x00000040U
  84. #define ALD_USB_CSR0L_REQPKT 0x00000020U
  85. #define ALD_USB_CSR0L_ERROR 0x00000010U
  86. #define ALD_USB_CSR0L_SETUPPKT 0x00000008U
  87. #define ALD_USB_CSR0L_STALLED 0x00000004U
  88. #define ALD_USB_CSR0L_TXRDY 0x00000002U
  89. #define ALD_USB_CSR0L_RXRDY 0x00000001U
  90. #define ALD_USB_CSR0L_SETENDC 0x00000080U
  91. #define ALD_USB_CSR0L_RXRDYC 0x00000040U
  92. #define ALD_USB_CSR0L_STALL 0x00000020U
  93. #define ALD_USB_CSR0L_SETEND 0x00000010U
  94. #define ALD_USB_CSR0L_DATAEND 0x00000008U
  95. #define ALD_USB_TXCSRL_NAKTO 0x00000080U
  96. #define ALD_USB_TXCSRL_CLRDT 0x00000040U
  97. #define ALD_USB_TXCSRL_STALLED 0x00000020U
  98. #define ALD_USB_TXCSRL_FLUSH 0x00000008U
  99. #define ALD_USB_TXCSRL_ERROR 0x00000004U
  100. #define ALD_USB_TXCSRL_FIFONE 0x00000002U
  101. #define ALD_USB_TXCSRL_TXRDY 0x00000001U
  102. #define ALD_USB_TXCSRL_STALL 0x00000010U
  103. #define ALD_USB_TXCSRL_UNDRUN 0x00000004U
  104. /* CSR0H_TXCSRH */
  105. #define ALD_USB_CSR0H_FLUSH 0x00000001U
  106. #define ALD_USB_TXCSRH_AUTOSET 0x00000080U
  107. #define ALD_USB_TXCSRH_ISO 0x00000040U
  108. #define ALD_USB_TXCSRH_MODE 0x00000020U
  109. #define ALD_USB_TXCSRH_FDT 0x00000008U
  110. /* RXCSRL */
  111. #define ALD_USB_RXCSRL_CLRDT 0x00000080U
  112. #define ALD_USB_RXCSRL_STALLED 0x00000040U
  113. #define ALD_USB_RXCSRL_REQPKT 0x00000020U
  114. #define ALD_USB_RXCSRL_FLUSH 0x00000010U
  115. #define ALD_USB_RXCSRL_DATAERR_NAKTO 0x00000008U
  116. #define ALD_USB_RXCSRL_ERROR 0x00000004U
  117. #define ALD_USB_RXCSRL_FULL 0x00000002U
  118. #define ALD_USB_RXCSRL_RXRDY 0x00000001U
  119. #define ALD_USB_RXCSRL_STALL 0x00000020U
  120. #define ALD_USB_RXCSRL_DATAERR 0x00000008U
  121. #define ALD_USB_RXCSRL_OVERRUN 0x00000004U
  122. /* RXCSRH */
  123. #define ALD_USB_RXCSRL_AUTOCLR 0x00000080U
  124. #define ALD_USB_RXCSRL_AUTOREQ 0x00000040U
  125. #define ALD_USB_RXCSRL_ISO 0x00000040U
  126. /* TXTYPE */
  127. #define ALD_USB_TXTYPE_PROTOCOL 0x00000030U
  128. #define ALD_USB_TXTYPE1_PROTOCOL_CTRL 0x00000000U
  129. #define ALD_USB_TXTYPE_PROTOCOL_ISO 0x00000010U
  130. #define ALD_USB_TXTYPE_PROTOCOL_BULK 0x00000020U
  131. #define ALD_USB_TXTYPE_PROTOCOL_INT 0x00000030U
  132. #define ALD_USB_TXTYPE_TEPN_1 0x00000001U
  133. #define ALD_USB_TXTYPE_TEPN_2 0x00000002U
  134. #define ALD_USB_TXTYPE_TEPN_3 0x00000003U
  135. #define ALD_USB_TXTYPE_TEPN_4 0x00000004U
  136. #define ALD_USB_TXTYPE_TEPN_5 0x00000005U
  137. #define ALD_USB_TXTYPE_TEPN_6 0x00000006U
  138. /* RXTYPE */
  139. #define ALD_USB_RXTYPE_PROTOCOL_ISO 0x00000010U
  140. #define ALD_USB_RXTYPE_PROTOCOL_BULK 0x00000020U
  141. #define ALD_USB_RXTYPE_PROTOCOL_INT 0x00000030U
  142. #define ALD_USB_RXTYPE_TEPN_1 0x00000001U
  143. #define ALD_USB_RXTYPE_TEPN_2 0x00000002U
  144. #define ALD_USB_RXTYPE_TEPN_3 0x00000003U
  145. #define ALD_USB_RXTYPE_TEPN_4 0x00000004U
  146. #define ALD_USB_RXTYPE_TEPN_5 0x00000005U
  147. #define ALD_USB_RXTYPE_TEPN_6 0x00000006U
  148. /* TXFIFO2 */
  149. #define ALD_USB_TXFIFO2_MAXPKTSIZE_1024 0x000000E0U
  150. #define ALD_USB_TXFIFO2_MAXPKTSIZE_512 0x000000C0U
  151. #define ALD_USB_TXFIFO2_MAXPKTSIZE_256 0x000000A0U
  152. #define ALD_USB_TXFIFO2_MAXPKTSIZE_128 0x00000080U
  153. #define ALD_USB_TXFIFO2_MAXPKTSIZE_64 0x00000060U
  154. #define ALD_USB_TXFIFO2_MAXPKTSIZE_32 0x00000040U
  155. #define ALD_USB_TXFIFO2_MAXPKTSIZE_16 0x00000020U
  156. #define ALD_USB_TXFIFO2_DPB 0x00000010U
  157. #define ALD_USB_TXFIFO2_ADDRH 0x00000007U
  158. /* RXFIFO2 */
  159. #define ALD_USB_RXFIFO2_MAXPKTSIZE_1024 0x000000E0U
  160. #define ALD_USB_RXFIFO2_MAXPKTSIZE_512 0x000000C0U
  161. #define ALD_USB_RXFIFO2_MAXPKTSIZE_256 0x000000A0U
  162. #define ALD_USB_RXFIFO2_MAXPKTSIZE_128 0x00000080U
  163. #define ALD_USB_RXFIFO2_MAXPKTSIZE_64 0x00000060U
  164. #define ALD_USB_RXFIFO2_MAXPKTSIZE_32 0x00000040U
  165. #define ALD_USB_RXFIFO2_MAXPKTSIZE_16 0x00000020U
  166. #define ALD_USB_RXFIFO2_DPB 0x00000010U
  167. /* TXIER */
  168. #define ALD_USB_TXIER_EP6IE 0x00000040U
  169. #define ALD_USB_TXIER_EP5IE 0x00000020U
  170. #define ALD_USB_TXIER_EP4IE 0x00000010U
  171. #define ALD_USB_TXIER_EP3IE 0x00000008U
  172. #define ALD_USB_TXIER_EP2IE 0x00000004U
  173. #define ALD_USB_TXIER_EP1IE 0x00000002U
  174. #define ALD_USB_TXIER_EP0IE 0x00000001U
  175. /* RXIER */
  176. #define ALD_USB_RXIER_EP6IE 0x00000040U
  177. #define ALD_USB_RXIER_EP5IE 0x00000020U
  178. #define ALD_USB_RXIER_EP4IE 0x00000010U
  179. #define ALD_USB_RXIER_EP3IE 0x00000008U
  180. #define ALD_USB_RXIER_EP2IE 0x00000004U
  181. #define ALD_USB_RXIER_EP1IE 0x00000002U
  182. /* TXIDR */
  183. #define ALD_USB_TXIDR_EP6ID 0x00000040U
  184. #define ALD_USB_TXIDR_EP5ID 0x00000020U
  185. #define ALD_USB_TXIDR_EP4ID 0x00000010U
  186. #define ALD_USB_TXIDR_EP3ID 0x00000008U
  187. #define ALD_USB_TXIDR_EP2ID 0x00000004U
  188. #define ALD_USB_TXIDR_EP1ID 0x00000002U
  189. #define ALD_USB_TXIDR_EP0ID 0x00000001U
  190. /* RXIDR */
  191. #define ALD_USB_RXIDR_EP6ID 0x00000040U
  192. #define ALD_USB_RXIDR_EP5ID 0x00000020U
  193. #define ALD_USB_RXIDR_EP4ID 0x00000010U
  194. #define ALD_USB_RXIDR_EP3ID 0x00000008U
  195. #define ALD_USB_RXIDR_EP2ID 0x00000004U
  196. #define ALD_USB_RXIDR_EP1ID 0x00000002U
  197. /* TXIVS */
  198. #define ALD_USB_TXIVS_EP6IVS 0x00000040U
  199. #define ALD_USB_TXIVS_EP5IVS 0x00000020U
  200. #define ALD_USB_TXIVS_EP4IVS 0x00000010U
  201. #define ALD_USB_TXIVS_EP3IVS 0x00000008U
  202. #define ALD_USB_TXIVS_EP2IVS 0x00000004U
  203. #define ALD_USB_TXIVS_EP1IVS 0x00000002U
  204. #define ALD_USB_TXIVS_EP0IVS 0x00000001U
  205. /* RXIVS */
  206. #define ALD_USB_RXIVS_EP6IVS 0x00000040U
  207. #define ALD_USB_RXIVS_EP5IVS 0x00000020U
  208. #define ALD_USB_RXIVS_EP4IVS 0x00000010U
  209. #define ALD_USB_RXIVS_EP3IVS 0x00000008U
  210. #define ALD_USB_RXIVS_EP2IVS 0x00000004U
  211. #define ALD_USB_RXIVS_EP1IVS 0x00000002U
  212. /* TXRIF */
  213. #define ALD_USB_TXRIF_EP6RIF 0x00000040U
  214. #define ALD_USB_TXRIF_EP5RIF 0x00000020U
  215. #define ALD_USB_TXRIF_EP4RIF 0x00000010U
  216. #define ALD_USB_TXRIF_EP3RIF 0x00000008U
  217. #define ALD_USB_TXRIF_EP2RIF 0x00000004U
  218. #define ALD_USB_TXRIF_EP1RIF 0x00000002U
  219. #define ALD_USB_TXRIF_EP0RIF 0x00000001U
  220. /* RXRIF */
  221. #define ALD_USB_RXRIF_EP6RIF 0x00000040U
  222. #define ALD_USB_RXRIF_EP5RIF 0x00000020U
  223. #define ALD_USB_RXRIF_EP4RIF 0x00000010U
  224. #define ALD_USB_RXRIF_EP3RIF 0x00000008U
  225. #define ALD_USB_RXRIF_EP2RIF 0x00000004U
  226. #define ALD_USB_RXRIF_EP1RIF 0x00000002U
  227. /* TXIFM */
  228. #define ALD_USB_TXIFM_EP6IFM 0x00000040U
  229. #define ALD_USB_TXIFM_EP5IFM 0x00000020U
  230. #define ALD_USB_TXIFM_EP4IFM 0x00000010U
  231. #define ALD_USB_TXIFM_EP3IFM 0x00000008U
  232. #define ALD_USB_TXIFM_EP2IFM 0x00000004U
  233. #define ALD_USB_TXIFM_EP1IFM 0x00000002U
  234. #define ALD_USB_TXIFM_EP0IFM 0x00000001U
  235. /* RXIFM */
  236. #define ALD_USB_RXIFM_EP6IFM 0x00000040U
  237. #define ALD_USB_RXIFM_EP5IFM 0x00000020U
  238. #define ALD_USB_RXIFM_EP4IFM 0x00000010U
  239. #define ALD_USB_RXIFM_EP3IFM 0x00000008U
  240. #define ALD_USB_RXIFM_EP2IFM 0x00000004U
  241. #define ALD_USB_RXIFM_EP1IFM 0x00000002U
  242. /* TXICR */
  243. #define ALD_USB_TXICR_EP6ICR 0x00000040U
  244. #define ALD_USB_TXICR_EP5ICR 0x00000020U
  245. #define ALD_USB_TXICR_EP4ICR 0x00000010U
  246. #define ALD_USB_TXICR_EP3ICR 0x00000008U
  247. #define ALD_USB_TXICR_EP2ICR 0x00000004U
  248. #define ALD_USB_TXICR_EP1ICR 0x00000002U
  249. #define ALD_USB_TXICR_EP0ICR 0x00000001U
  250. /* RXICR */
  251. #define ALD_USB_RXICR_EP6ICR 0x00000040U
  252. #define ALD_USB_RXICR_EP5ICR 0x00000020U
  253. #define ALD_USB_RXICR_EP4ICR 0x00000010U
  254. #define ALD_USB_RXICR_EP3ICR 0x00000008U
  255. #define ALD_USB_RXICR_EP2ICR 0x00000004U
  256. #define ALD_USB_RXICR_EP1ICR 0x00000002U
  257. /* IER */
  258. #define ALD_USB_IER_STATUS 0x000000FFU
  259. #define ALD_USB_IER_SESREQIE 0x00000040U
  260. #define ALD_USB_IER_DISCONIE 0x00000020U
  261. #define ALD_USB_IER_CONIE 0x00000010U
  262. #define ALD_USB_IER_SOFIE 0x00000008U
  263. #define ALD_USB_IER_BABIE 0x00000004U
  264. #define ALD_USB_IER_RESIE 0x00000002U
  265. /* IDR */
  266. #define ALD_USB_IDR_STATUS 0x000000FFU
  267. #define ALD_USB_IDR_SESREQID 0x00000040U
  268. #define ALD_USB_IDR_DISCONID 0x00000020U
  269. #define ALD_USB_IDR_CONID 0x00000010U
  270. #define ALD_USB_IDR_SOFID 0x00000008U
  271. #define ALD_USB_IDR_BABID 0x00000004U
  272. #define ALD_USB_IDR_RESID 0x00000002U
  273. /* IVS */
  274. #define ALD_USB_IVS_SESREQIVS 0x00000040U
  275. #define ALD_USB_IVS_DISCONIVS 0x00000020U
  276. #define ALD_USB_IVS_CONIVS 0x00000010U
  277. #define ALD_USB_IVS_SOFIVS 0x00000008U
  278. #define ALD_USB_IVS_BABIVS 0x00000004U
  279. #define ALD_USB_IVS_RESIVS 0x00000002U
  280. /* RIF */
  281. #define ALD_USB_RIF_SESREQRIF 0x00000040U
  282. #define ALD_USB_RIF_DISCONRIF 0x00000020U
  283. #define ALD_USB_RIF_CONRIF 0x00000010U
  284. #define ALD_USB_RIF_SOFRIF 0x00000008U
  285. #define ALD_USB_RIF_BABRIF 0x00000004U
  286. #define ALD_USB_RIF_RESRIF 0x00000002U
  287. /* IFM */
  288. #define ALD_USB_IFM_SESREQIFM 0x00000040U
  289. #define ALD_USB_IFM_DISCONIFM 0x00000020U
  290. #define ALD_USB_IFM_CONIFM 0x00000010U
  291. #define ALD_USB_IFM_SOFIFM 0x00000008U
  292. #define ALD_USB_IFM_BABIFM 0x00000004U
  293. #define ALD_USB_IFM_RESIFM 0x00000002U
  294. /* ICR */
  295. #define ALD_USB_ICR_SESREQICR 0x00000040U
  296. #define ALD_USB_ICR_DISCONICR 0x00000020U
  297. #define ALD_USB_ICR_CONICR 0x00000010U
  298. #define ALD_USB_ICR_SOFICR 0x00000008U
  299. #define ALD_USB_ICR_BABICR 0x00000004U
  300. #define ALD_USB_ICR_RESICR 0x00000002U
  301. #define ALD_MAX_NAK_LIMIT 255U
  302. #define ALD_DISABLE_NAK_LIMIT 0U
  303. #define ALD_USB_RX_EPSTATUS_SHIFT 16U
  304. #define ALD_USB_INTEP_RX_SHIFT 16U
  305. #define ALD_MAX_PACKET_SIZE_EP0 64U
  306. #define ALD_USB_TXTYPE1_PROTO_M 0x00000030U
  307. #define ALD_USB_TXTYPE1_PROTO_CTRL 0x00000000U
  308. #define ALD_USB_TXTYPE1_PROTO_ISOC 0x00000010U
  309. #define ALD_USB_TXTYPE1_PROTO_BULK 0x00000020U
  310. #define ALD_USB_TXTYPE1_PROTO_INT 0x00000030U
  311. #define ALD_USB_FIFO_SZ_8 0x00000000U
  312. #define ALD_USB_FIFO_SZ_16 0x00000001U
  313. #define ALD_USB_FIFO_SZ_32 0x00000002U
  314. #define ALD_USB_FIFO_SZ_64 0x00000003U
  315. #define ALD_USB_FIFO_SZ_128 0x00000004U
  316. #define ALD_USB_FIFO_SZ_256 0x00000005U
  317. #define ALD_USB_FIFO_SZ_512 0x00000006U
  318. #define ALD_USB_FIFO_SZ_1024 0x00000007U
  319. #define ALD_USB_FIFO_SZ_2048 0x00000008U
  320. #define ALD_USBFIFOSizeToBytes(x) (8 << (x))
  321. #define ALD_USB_TRANS_OUT 0x00000102U
  322. #define ALD_USB_TRANS_IN 0x00000102U
  323. #define ALD_USB_TRANS_IN_LAST 0x0000010aU
  324. #define ALD_USB_TRANS_SETUP 0x0000110aU
  325. #define ALD_USB_TRANS_STATUS 0x00000142U
  326. #define ALD_USB_RX_EPSTATUS_SHIFT 16U
  327. #define ALD_USB_INTEP_RX_SHIFT 16U
  328. #define ALD_USB_UNDEF_SPEED 0x80000000U
  329. #define ALD_USB_HIGH_SPEED 0x00000002U
  330. #define ALD_USB_FULL_SPEED 0x00000001U
  331. #define ALD_USB_LOW_SPEED 0x00000000U
  332. #define ALD_USB_EP_AUTO_SET 0x00000001
  333. #define ALD_USB_EP_AUTO_REQUEST 0x00000002
  334. #define ALD_USB_EP_AUTO_CLEAR 0x00000004
  335. #define ALD_USB_EP_DUAL_BUFFERING 0x00000008
  336. #define ALD_USB_EP_DMA_MODE_0 0x00000008
  337. #define ALD_USB_EP_DMA_MODE_1 0x00000010
  338. #define ALD_USB_EP_DIS_NYET 0x00000020
  339. #define ALD_USB_EP_MODE_ISOC 0x00000000 // Isochronous endpoint
  340. #define ALD_USB_EP_MODE_BULK 0x00000100 // Bulk endpoint
  341. #define ALD_USB_EP_MODE_INT 0x00000200 // Interrupt endpoint
  342. #define ALD_USB_EP_MODE_CTRL 0x00000300 // Control endpoint
  343. #define ALD_USB_EP_MODE_MASK 0x00000300 // Mode Mask
  344. #define ALD_USB_EP_SPEED_LOW 0x00000000 // Low Speed
  345. #define ALD_USB_EP_SPEED_FULL 0x00001000 // Full Speed
  346. #define ALD_USB_EP_SPEED_HIGH 0x00004000 // High Speed
  347. #define ALD_USB_EP_HOST_IN 0x00000000 // Host IN endpoint
  348. #define ALD_USB_EP_HOST_OUT 0x00002000 // Host OUT endpoint
  349. #define ALD_USB_EP_DEV_IN 0x00002000 // Device IN endpoint
  350. #define ALD_USB_EP_DEV_OUT 0x00000000 // Device OUT endpoint
  351. #define ALD_USB_INTCTRL_ALL 0x000003FFU
  352. #define ALD_USB_INTCTRL_STATUS 0x000000FFU
  353. #define ALD_USB_INTCTRL_VBUS_ERR 0x00000080U
  354. #define ALD_USB_INTCTRL_SESSION 0x00000040U
  355. #define ALD_USB_INTCTRL_SESSION_END 0x00000040U
  356. #define ALD_USB_INTCTRL_DISCONNECT 0x00000020U
  357. #define ALD_USB_INTCTRL_CONNECT 0x00000010U
  358. #define ALD_USB_INTCTRL_SOF 0x00000008U
  359. #define ALD_USB_INTCTRL_BABBLE 0x00000004U
  360. #define ALD_USB_INTCTRL_RESET 0x00000004U
  361. #define ALD_USB_INTCTRL_RESUME 0x00000002U
  362. #define ALD_USB_INTCTRL_SUSPEND 0x00000001U
  363. #define ALD_USB_INTCTRL_MODE_DETECT 0x00000200U
  364. #define ALD_USB_INTCTRL_POWER_FAULT 0x00000100U
  365. #define ALD_USB_INTEP_ALL 0xFFFFFFFFU
  366. #define ALD_USB_INTEP_HOST_IN 0x001E0000U
  367. #define ALD_USB_INTEP_HOST_IN_15 0x80000000U
  368. #define ALD_USB_INTEP_HOST_IN_14 0x40000000U
  369. #define ALD_USB_INTEP_HOST_IN_13 0x20000000U
  370. #define ALD_USB_INTEP_HOST_IN_12 0x10000000U
  371. #define ALD_USB_INTEP_HOST_IN_11 0x08000000U
  372. #define ALD_USB_INTEP_HOST_IN_10 0x04000000U
  373. #define ALD_USB_INTEP_HOST_IN_9 0x02000000U
  374. #define ALD_USB_INTEP_HOST_IN_8 0x01000000U
  375. #define ALD_USB_INTEP_HOST_IN_7 0x00800000U
  376. #define ALD_USB_INTEP_HOST_IN_6 0x00400000U
  377. #define ALD_USB_INTEP_HOST_IN_5 0x00200000U
  378. #define ALD_USB_INTEP_HOST_IN_4 0x00100000U
  379. #define ALD_USB_INTEP_HOST_IN_3 0x00080000U
  380. #define ALD_USB_INTEP_HOST_IN_2 0x00040000U
  381. #define ALD_USB_INTEP_HOST_IN_1 0x00020000U
  382. #define ALD_USB_INTEP_DEV_OUT 0x001E0000U
  383. #define ALD_USB_INTEP_DEV_OUT_15 0x80000000U
  384. #define ALD_USB_INTEP_DEV_OUT_14 0x40000000U
  385. #define ALD_USB_INTEP_DEV_OUT_13 0x20000000U
  386. #define ALD_USB_INTEP_DEV_OUT_12 0x10000000U
  387. #define ALD_USB_INTEP_DEV_OUT_11 0x08000000U
  388. #define ALD_USB_INTEP_DEV_OUT_10 0x04000000U
  389. #define ALD_USB_INTEP_DEV_OUT_9 0x02000000U
  390. #define ALD_USB_INTEP_DEV_OUT_8 0x01000000U
  391. #define ALD_USB_INTEP_DEV_OUT_7 0x00800000U
  392. #define ALD_USB_INTEP_DEV_OUT_6 0x00400000U
  393. #define ALD_USB_INTEP_DEV_OUT_5 0x00200000U
  394. #define ALD_USB_INTEP_DEV_OUT_4 0x00100000U
  395. #define ALD_USB_INTEP_DEV_OUT_3 0x00080000U
  396. #define ALD_USB_INTEP_DEV_OUT_2 0x00040000U
  397. #define ALD_USB_INTEP_DEV_OUT_1 0x00020000U
  398. #define ALD_USB_INTEP_HOST_OUT 0x0000001EU
  399. #define ALD_USB_INTEP_HOST_OUT_15 0x00008000U
  400. #define ALD_USB_INTEP_HOST_OUT_14 0x00004000U
  401. #define ALD_USB_INTEP_HOST_OUT_13 0x00002000U
  402. #define ALD_USB_INTEP_HOST_OUT_12 0x00001000U
  403. #define ALD_USB_INTEP_HOST_OUT_11 0x00000800U
  404. #define ALD_USB_INTEP_HOST_OUT_10 0x00000400U
  405. #define ALD_USB_INTEP_HOST_OUT_9 0x00000200U
  406. #define ALD_USB_INTEP_HOST_OUT_8 0x00000100U
  407. #define ALD_USB_INTEP_HOST_OUT_7 0x00000080U
  408. #define ALD_USB_INTEP_HOST_OUT_6 0x00000040U
  409. #define ALD_USB_INTEP_HOST_OUT_5 0x00000020U
  410. #define ALD_USB_INTEP_HOST_OUT_4 0x00000010U
  411. #define ALD_USB_INTEP_HOST_OUT_3 0x00000008U
  412. #define ALD_USB_INTEP_HOST_OUT_2 0x00000004U
  413. #define ALD_USB_INTEP_HOST_OUT_1 0x00000002U
  414. #define ALD_USB_INTEP_DEV_IN 0x0000001EU
  415. #define ALD_USB_INTEP_DEV_IN_15 0x00008000U
  416. #define ALD_USB_INTEP_DEV_IN_14 0x00004000U
  417. #define ALD_USB_INTEP_DEV_IN_13 0x00002000U
  418. #define ALD_USB_INTEP_DEV_IN_12 0x00001000U
  419. #define ALD_USB_INTEP_DEV_IN_11 0x00000800U
  420. #define ALD_USB_INTEP_DEV_IN_10 0x00000400U
  421. #define ALD_USB_INTEP_DEV_IN_9 0x00000200U
  422. #define ALD_USB_INTEP_DEV_IN_8 0x00000100U
  423. #define ALD_USB_INTEP_DEV_IN_7 0x00000080U
  424. #define ALD_USB_INTEP_DEV_IN_6 0x00000040U
  425. #define ALD_USB_INTEP_DEV_IN_5 0x00000020U
  426. #define ALD_USB_INTEP_DEV_IN_4 0x00000010U
  427. #define ALD_USB_INTEP_DEV_IN_3 0x00000008U
  428. #define ALD_USB_INTEP_DEV_IN_2 0x00000004U
  429. #define ALD_USB_INTEP_DEV_IN_1 0x00000002U
  430. #define ALD_USB_INTEP_0 0x00000001U
  431. #define ALD_USB_UNDEF_SPEED 0x80000000U
  432. #define ALD_USB_HIGH_SPEED 0x00000002U
  433. #define ALD_USB_FULL_SPEED 0x00000001U
  434. #define ALD_USB_LOW_SPEED 0x00000000U
  435. #define ALD_USB_HOST_IN_STATUS 0x114F0000U
  436. #define ALD_USB_HOST_IN_PID_ERROR 0x10000000U
  437. #define ALD_USB_HOST_IN_NOT_COMP 0x01000000U
  438. #define ALD_USB_HOST_IN_STALL 0x00400000U
  439. #define ALD_USB_HOST_IN_DATA_ERROR 0x00080000U
  440. #define ALD_USB_HOST_IN_NAK_TO 0x00080000U
  441. #define ALD_USB_HOST_IN_ERROR 0x00040000U
  442. #define ALD_USB_HOST_IN_FIFO_FULL 0x00020000U
  443. #define ALD_USB_HOST_IN_PKTRDY 0x00010000U
  444. #define ALD_USB_HOST_OUT_STATUS 0x000000A7U
  445. #define ALD_USB_HOST_OUT_NAK_TO 0x00000080U
  446. #define ALD_USB_HOST_OUT_NOT_COMP 0x00000080U
  447. #define ALD_USB_HOST_OUT_STALL 0x00000020U
  448. #define ALD_USB_HOST_OUT_ERROR 0x00000004U
  449. #define ALD_USB_HOST_OUT_FIFO_NE 0x00000002U
  450. #define ALD_USB_HOST_OUT_PKTPEND 0x00000001U
  451. #define ALD_USB_HOST_EP0_NAK_TO 0x00000080U
  452. #define ALD_USB_HOST_EP0_STATUS 0x00000040U
  453. #define ALD_USB_HOST_EP0_ERROR 0x00000010U
  454. #define ALD_USB_HOST_EP0_RX_STALL 0x00000004U
  455. #define ALD_USB_HOST_EP0_RXPKTRDY 0x00000001U
  456. #define ALD_USB_DEV_RX_PID_ERROR 0x01000000U
  457. #define ALD_USB_DEV_RX_SENT_STALL 0x00400000U
  458. #define ALD_USB_DEV_RX_DATA_ERROR 0x00080000U
  459. #define ALD_USB_DEV_RX_OVERRUN 0x00040000U
  460. #define ALD_USB_DEV_RX_FIFO_FULL 0x00020000U
  461. #define ALD_USB_DEV_RX_PKT_RDY 0x00010000U
  462. #define ALD_USB_DEV_TX_NOT_COMP 0x00000080U
  463. #define ALD_USB_DEV_TX_SENT_STALL 0x00000020U
  464. #define ALD_USB_DEV_TX_UNDERRUN 0x00000004U
  465. #define ALD_USB_DEV_TX_FIFO_NE 0x00000002U
  466. #define ALD_USB_DEV_TX_TXPKTRDY 0x00000001U
  467. #define ALD_USB_DEV_EP0_SETUP_END 0x00000010U
  468. #define ALD_USB_DEV_EP0_SENT_STALL 0x00000004U
  469. #define ALD_USB_DEV_EP0_IN_PKTPEND 0x00000002U
  470. #define ALD_USB_DEV_EP0_OUT_PKTRDY 0x00000001U
  471. #define ALD_USB_EP_0 0x00000000U
  472. #define ALD_USB_EP_1 0x00000001U
  473. #define ALD_USB_EP_2 0x00000002U
  474. #define ALD_USB_EP_3 0x00000003U
  475. #define ALD_USB_EP_4 0x00000004U
  476. #define ALD_USB_EP_5 0x00000005U
  477. #define ALD_USB_EP_6 0x00000006U
  478. #define ALD_USB_EP_7 0x00000007U
  479. #define ALD_NUM_USB_EP 8U
  480. #define ALD_USB_FIFO_SZ_8 0x00000000U
  481. #define ALD_USB_FIFO_SZ_16 0x00000001U
  482. #define ALD_USB_FIFO_SZ_32 0x00000002U
  483. #define ALD_USB_FIFO_SZ_64 0x00000003U
  484. #define ALD_USB_FIFO_SZ_128 0x00000004U
  485. #define ALD_USB_FIFO_SZ_256 0x00000005U
  486. #define ALD_USB_FIFO_SZ_512 0x00000006U
  487. #define ALD_USB_FIFO_SZ_1024 0x00000007U
  488. #define ALD_USB_FIFO_SZ_2048 0x00000008U
  489. #define ALD_USB_TRANS_OUT 0x00000102U
  490. #define ALD_USB_TRANS_IN 0x00000102U
  491. #define ALD_USB_TRANS_IN_LAST 0x0000010aU
  492. #define ALD_USB_TRANS_SETUP 0x0000110aU
  493. #define ALD_USB_TRANS_STATUS 0x00000142U
  494. #define ALD_USB_DMA_EP_CFG_TX 0x00000001U
  495. #define ALD_USB_DMA_EP_CFG_RX_DEV 0x00000002U
  496. #define ALD_USB_DMA_EP_CFG_RX_HOST 0x00000004U
  497. #define ALD_USB_DMA_EP_TX_MSK 0x94U
  498. #define ALD_USB_DMA_EP_RX_DEV_MSK 0xA8U
  499. #define ALD_USB_DMA_EP_RX_HOST_MSK 0xE8U
  500. #define ALD_USB_INTLPM_ERROR 0x00000020U
  501. #define ALD_USB_INTLPM_RESUME 0x00000010U
  502. #define ALD_USB_INTLPM_INCOMPLETE 0x00000008U
  503. #define ALD_USB_INTLPM_ACK 0x00000004U
  504. #define ALD_USB_INTLPM_NYET 0x00000002U
  505. #define ALD_USB_INTLPM_STALL 0x00000001U
  506. #define ALD_USB_DEV_LPM_NAK 0x00000010U
  507. #define ALD_USB_DEV_LPM_NONE 0x00000000U
  508. #define ALD_USB_DEV_LPM_EN 0x0000000cU
  509. #define ALD_USB_DEV_LPM_EXTONLY 0x00000004U
  510. #define ALD_USB_HOST_LPM_RMTWAKE 0x00000100U
  511. #define ALD_USB_HOST_LPM_L1 0x00000001U
  512. #define ALD_USB_DEV_LPM_LS_RMTWAKE 0x00000100U
  513. #define ALD_USB_DEV_LPM_LS_L1 0x00000001U
  514. #define ALD_USB_HOST_PWRFLT_LOW 0x00000010U
  515. #define ALD_USB_HOST_PWRFLT_HIGH 0x00000030U
  516. #define ALD_USB_HOST_PWRFLT_EP_NONE 0x00000000U
  517. #define ALD_USB_HOST_PWRFLT_EP_TRI 0x00000140U
  518. #define ALD_USB_HOST_PWRFLT_EP_LOW 0x00000240U
  519. #define ALD_USB_HOST_PWRFLT_EP_HIGH 0x00000340U
  520. #define ALD_USB_HOST_PWREN_MAN_LOW 0x00000000U
  521. #define ALD_USB_HOST_PWREN_MAN_HIGH 0x00000001U
  522. #define ALD_USB_HOST_PWREN_AUTOLOW 0x00000002U
  523. #define ALD_USB_HOST_PWREN_AUTOHIGH 0x00000003U
  524. #define ALD_USB_HOST_PWREN_FILTER 0x00010000U
  525. /**
  526. * @}
  527. */
  528. /**
  529. * @defgroup USB_Public_Types USB Public Types
  530. * @{
  531. */
  532. /**
  533. * @brief USB DP/DM line push-up or push-down
  534. */
  535. typedef enum {
  536. ALD_USB_DPDM_FLOATING = 0x0U, /**< Floating */
  537. ALD_USB_DPDM_PUSH_UP = 0x1U, /**< Push-Up */
  538. ALD_USB_DPDM_PUSH_DOWN = 0x2U, /**< Push-Down */
  539. } ald_dpdm_push_t;
  540. /**
  541. * @}
  542. */
  543. /** @addtogroup USB_Public_Functions
  544. * @{
  545. */
  546. /** @addtogroup USB_Public_Functions_Group1
  547. * @{
  548. */
  549. /* Base functions */
  550. extern uint32_t ald_usb_frame_number_get(void);
  551. extern void ald_usb_otg_session_request(bool start);
  552. extern uint32_t ald_usb_mode_get(void);
  553. extern uint32_t ald_usb_mode_host_req(void);
  554. extern uint32_t ald_usb_mode_host_req_clear(void);
  555. extern void ald_usb_high_speed_enable(bool enable);
  556. extern uint32_t ald_usb_device_speed_get(void);
  557. extern uint32_t ald_usb_num_ep_get( void);
  558. extern void ald_usb_control_reset(void);
  559. void ald_usb_dppud_set(ald_dpdm_push_t pupd);
  560. void ald_usb_dmpud_set(ald_dpdm_push_t pupd);
  561. void ald_usb_swcid_cidctrl(uint8_t cid);
  562. void ald_usb_swcid_host(uint8_t host);
  563. /**
  564. * @}
  565. */
  566. /** @addtogroup USB_Public_Functions_Group2
  567. * @{
  568. */
  569. /* Device functions */
  570. extern uint8_t ald_usb_dev_get_addr(void);
  571. extern void ald_usb_dev_set_addr(uint8_t addr);
  572. extern void ald_usb_dev_connect(void);
  573. extern void ald_usb_dev_disconnect(void);
  574. extern void ald_usb_dev_suspend_enable(void);
  575. extern void ald_usb_dev_ep_config(uint32_t ep_idx, uint32_t p_max, uint32_t flags);
  576. extern void ald_usb_dev_ep_get_config(uint32_t ep_idx, uint32_t *p_max, uint32_t *flags);
  577. extern void ald_usb_dev_ep_data_ack(uint32_t ep_idx, bool last);
  578. extern void ald_usb_dev_ep_stall(uint32_t ep_idx, uint32_t flags);
  579. extern void ald_usb_dev_ep_stall_clear(uint32_t ep_idx, uint32_t flags);
  580. extern void ald_usb_dev_ep_status_clear(uint32_t ep_idx, uint32_t flags);
  581. /**
  582. * @}
  583. */
  584. /** @addtogroup USB_Public_Functions_Group3
  585. * @{
  586. */
  587. /* Host functions */
  588. extern uint32_t ald_usb_host_addr_get(uint32_t ep_idx, uint32_t flags);
  589. extern void ald_usb_host_addr_set(uint32_t ep_idx, uint32_t addr, uint32_t flags);
  590. extern void ald_usb_host_ep_config(uint32_t ep_idx, uint32_t p_max, uint32_t nak_val, uint32_t t_ep, uint32_t flags);
  591. extern void ald_usb_host_ep_data_ack(uint32_t ep_idx);
  592. extern void ald_usb_host_ep_data_toggle(uint32_t ep_idx, bool toggle, uint32_t flags);
  593. extern void ald_usb_host_ep_status_clear(uint32_t ep_idx, uint32_t flags);
  594. extern uint32_t ald_usb_host_hub_addr_get(uint32_t ep_idx, uint32_t flags);
  595. extern void ald_usb_host_hub_addr_set(uint32_t ep_idx, uint32_t addr, uint32_t flags);
  596. extern void ald_usb_host_pwr_disable(void);
  597. extern void ald_usb_host_pwr_enable(void);
  598. extern void ald_usb_host_pwr_config(uint32_t flags);
  599. extern void ald_usb_host_pwr_fault_disable(void);
  600. extern void ald_usb_host_pwr_fault_enable(void);
  601. extern void ald_usb_host_request_in(uint32_t ep_idx);
  602. extern void ald_usb_host_request_in_clear(uint32_t ep_idx);
  603. extern void ald_usb_host_request_status(void);
  604. extern void ald_usb_host_reset(bool start);
  605. extern void ald_usb_host_resume(bool start);
  606. extern void ald_usb_host_suspend(void);
  607. extern uint32_t ald_usb_host_speed_get(void);
  608. extern void ald_usb_host_ep_speed_set(uint32_t ep_idx, uint32_t flags);
  609. extern void ald_usb_host_ep_ping(uint32_t ep_idx, bool enable);
  610. /**
  611. * @}
  612. */
  613. /** @addtogroup USB_Public_Functions_Group4
  614. * @{
  615. */
  616. /* Endpoint functions */
  617. extern uint32_t ald_usb_ep_data_avail(uint32_t ep_idx);
  618. extern int32_t ald_usb_ep_data_get(uint32_t ep_idx, uint8_t *data, uint32_t *size);
  619. extern int32_t ald_usb_ep_data_put(uint32_t ep_idx, uint8_t *data, uint32_t size);
  620. extern int32_t ald_usb_ep_data_send(uint32_t ep_idx, uint32_t tx_type);
  621. extern void ald_usb_ep_data_toggle_clear(uint32_t ep_idx, uint32_t flags);
  622. extern void ald_usb_ep_req_packet_count(uint32_t ep_idx, uint32_t count);
  623. extern uint32_t ald_usb_ep_status(uint32_t ep_idx);
  624. extern void ald_usb_ep_dma_config(uint32_t ep_idx, uint32_t flag, type_func_t en);
  625. /**
  626. * @}
  627. */
  628. /** @addtogroup USB_Public_Functions_Group5
  629. * @{
  630. */
  631. /* FIFO functions */
  632. extern uint32_t ald_usb_fifo_addr_get(uint32_t ep_idx);
  633. extern void ald_usb_fifo_config_get(uint32_t ep_idx, uint32_t *addr, uint32_t *size, uint32_t flags);
  634. extern void ald_usb_fifo_config_set(uint32_t ep_idx, uint32_t addr, uint32_t size, uint32_t flags);
  635. extern void ald_usb_fifo_flush(uint32_t ep_idx, uint32_t flags);
  636. /**
  637. * @}
  638. */
  639. /** @addtogroup USB_Public_Functions_Group6
  640. * @{
  641. */
  642. /* Interrupt functions */
  643. extern void ald_usb_int_disable(uint32_t flags);
  644. extern void ald_usb_int_enable(uint32_t flags);
  645. extern uint32_t ald_usb_int_status_get(void);
  646. extern void ald_usb_int_disable_ep(uint32_t flags);
  647. extern void ald_usb_int_enable_ep(uint32_t flags);
  648. extern uint32_t ald_usb_int_status_ep_get(void);
  649. extern void ald_usb_int_register(void);
  650. extern void ald_usb_int_unregister(void);
  651. extern uint32_t ald_usb_int_num_get(void);
  652. /**
  653. * @}
  654. */
  655. /** @addtogroup USB_Public_Functions_Group7
  656. * @{
  657. */
  658. /* DMA functions */
  659. extern void ald_usb_dma_channel_config(uint8_t ch, uint32_t addr, uint32_t count, uint32_t ctrl);
  660. extern void ald_usb_dma_mult_recv_start(uint32_t ep_idx);
  661. extern void ald_usb_dma_channel_start(uint8_t ch);
  662. extern void ald_usb_dma_channel_stop(uint8_t ch);
  663. extern uint32_t ald_usb_dma_get_interrupt_flag(void);
  664. extern uint32_t ald_usb_dma_get_channel_error(uint8_t ch);
  665. extern void ald_usb_dma_clear_channel_error(uint8_t ch);
  666. /**
  667. * @}
  668. */
  669. /** @addtogroup USB_Public_Functions_Group8
  670. * @{
  671. */
  672. /* LPM functions */
  673. extern void ald_usb_host_lpm_send(uint32_t addr, uint32_t ep_idx);
  674. extern void ald_usb_host_lpm_config(uint32_t resume_time, uint32_t config);
  675. extern uint32_t ald_usb_lpm_remote_wake_is_enable(void);
  676. extern void ald_usb_host_lpm_resume(void);
  677. extern void ald_usb_dev_lpm_remote_wake(void);
  678. extern void ald_usb_dev_lpm_config(uint32_t config);
  679. extern void ald_usb_dev_lpm_enable(void);
  680. extern void ald_usb_dev_lpm_disable(void);
  681. extern uint32_t ald_usb_lpm_link_status_get(void);
  682. extern uint32_t ald_usb_lpm_ep_get(void);
  683. extern uint32_t ald_usb_lpm_int_status_get(void);
  684. extern void ald_usb_lpm_int_disable(uint32_t ints);
  685. extern void ald_usb_lpm_int_enable(uint32_t ints);
  686. /**
  687. * @}
  688. */
  689. /** @addtogroup USB_Public_Functions_Group9
  690. * @{
  691. */
  692. /* usb swvbus control functions */
  693. extern void ald_usb_swvbus_sigctl_set(uint8_t sigctl);
  694. extern uint8_t ald_usb_swvbus_sigctl_get(void);
  695. extern void ald_usb_swvbus_sesendth_set(uint8_t thd);
  696. extern uint8_t ald_usb_swvbus_sesendth_get(void);
  697. extern void ald_usb_swvbus_sesvalth_set(uint8_t thd);
  698. extern uint8_t ald_usb_swvbus_valth_get(void);
  699. extern void ald_usb_swvbus_valth_set(uint8_t thd);
  700. extern uint8_t ald_usb_swvbus_valth_get(void);
  701. /**
  702. * @}
  703. */
  704. /** @addtogroup USB_Public_Functions_Group10
  705. * @{
  706. */
  707. /* usb init functions */
  708. extern void ald_usb_host_components_init(void);
  709. extern void ald_usb_device_components_init(void);
  710. /**
  711. * @}
  712. */
  713. /**
  714. * @}
  715. */
  716. /**
  717. * @}
  718. */
  719. /**
  720. * @}
  721. */
  722. #ifdef __cplusplus
  723. }
  724. #endif /* __cplusplus */
  725. #endif /* __ALD_USB_H__ */