begriffs open source - cmsis/blob - CMSIS/Driver/DriverTemplates/Driver_USBH.c

   1 /*
   2  * Copyright (c) 2013-2024 Arm Limited. All rights reserved.
   3  *
   4  * SPDX-License-Identifier: Apache-2.0
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the License); you may
   7  * not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  14  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #include "Driver_USBH.h"
  20
  21 /* USB Host Driver */
  22
  23 #define ARM_USBH_DRV_VERSION    ARM_DRIVER_VERSION_MAJOR_MINOR(1, 0) /* driver version */
  24
  25 /* Driver Version */
  26 static const ARM_DRIVER_VERSION usbh_driver_version = {
  27     ARM_USBH_API_VERSION,
  28     ARM_USBH_DRV_VERSION
  29 };
  30
  31 /* Driver Capabilities */
  32 static const ARM_USBH_CAPABILITIES usbh_driver_capabilities = {
  33     0x0001, /* Root HUB available Ports Mask   */
  34     0,      /* Automatic SPLIT packet handling */
  35     0,      /* Signal Connect event */
  36     0,      /* Signal Disconnect event */
  37     0,      /* Signal Overcurrent event */
  38     0       /* Reserved (must be zero) */
  39 };
  40
  41 //
  42 // Functions
  43 //
  44
  45 static ARM_DRIVER_VERSION ARM_USBH_GetVersion(void)
  46 {
  47   return usbh_driver_version;
  48 }
  49
  50 static ARM_USBH_CAPABILITIES ARM_USBH_GetCapabilities(void)
  51 {
  52   return usbh_driver_capabilities;
  53 }
  54
  55 static int32_t ARM_USBH_Initialize(ARM_USBH_SignalPortEvent_t cb_port_event,
  56                                    ARM_USBH_SignalPipeEvent_t cb_pipe_event)
  57 {
  58 }
  59
  60 static int32_t ARM_USBH_Uninitialize(void)
  61 {
  62 }
  63
  64 static int32_t ARM_USBH_PowerControl(ARM_POWER_STATE state)
  65 {
  66     switch (state)
  67     {
  68     case ARM_POWER_OFF:
  69         break;
  70
  71     case ARM_POWER_LOW:
  72         break;
  73
  74     case ARM_POWER_FULL:
  75         break;
  76     }
  77     return ARM_DRIVER_OK;
  78 }
  79
  80 static int32_t ARM_USBH_PortVbusOnOff(uint8_t port, bool vbus)
  81 {
  82 }
  83
  84 static int32_t ARM_USBH_PortReset(uint8_t port)
  85 {
  86 }
  87
  88 static int32_t ARM_USBH_PortSuspend(uint8_t port)
  89 {
  90 }
  91
  92 static int32_t ARM_USBH_PortResume(uint8_t port)
  93 {
  94 }
  95
  96 static ARM_USBH_PORT_STATE ARM_USBH_PortGetState(uint8_t port)
  97 {
  98 }
  99
 100 static ARM_USBH_PIPE_HANDLE ARM_USBH_PipeCreate(uint8_t  dev_addr,
 101                                                 uint8_t  dev_speed,
 102                                                 uint8_t  hub_addr,
 103                                                 uint8_t  hub_port,
 104                                                 uint8_t  ep_addr,
 105                                                 uint8_t  ep_type,
 106                                                 uint16_t ep_max_packet_size,
 107                                                 uint8_t  ep_interval)
 108 {
 109 }
 110
 111 static int32_t ARM_USBH_PipeModify(ARM_USBH_PIPE_HANDLE pipe_hndl,
 112                             uint8_t  dev_addr,
 113                             uint8_t  dev_speed,
 114                             uint8_t  hub_addr,
 115                             uint8_t  hub_port,
 116                             uint16_t ep_max_packet_size)
 117 {
 118 }
 119
 120 static int32_t ARM_USBH_PipeDelete(ARM_USBH_PIPE_HANDLE pipe_hndl)
 121 {
 122 }
 123
 124 static int32_t ARM_USBH_PipeReset(ARM_USBH_PIPE_HANDLE pipe_hndl)
 125 {
 126 }
 127
 128 static int32_t ARM_USBH_PipeTransfer(ARM_USBH_PIPE_HANDLE pipe_hndl,
 129                               uint32_t packet,
 130                               uint8_t *data,
 131                               uint32_t num)
 132 {
 133 }
 134
 135 static uint32_t ARM_USBH_PipeTransferGetResult(ARM_USBH_PIPE_HANDLE pipe_hndl)
 136 {
 137 }
 138
 139 static int32_t ARM_USBH_PipeTransferAbort(ARM_USBH_PIPE_HANDLE pipe_hndl)
 140 {
 141 }
 142
 143 static uint16_t ARM_USBH_GetFrameNumber(void)
 144 {
 145 }
 146
 147 static void ARM_USBH_SignalPortEvent(uint8_t port, uint32_t event)
 148 {
 149     // function body
 150 }
 151
 152 static void ARM_USBH_SignalPipeEvent(ARM_USBH_PIPE_HANDLE pipe_hndl, uint32_t event)
 153 {
 154     // function body
 155 }
 156
 157 // End USBH Interface
 158
 159 extern \
 160 ARM_DRIVER_USBH Driver_USBH0;
 161 ARM_DRIVER_USBH Driver_USBH0 = {
 162   ARM_USBH_GetVersion,
 163   ARM_USBH_GetCapabilities,
 164   ARM_USBH_Initialize,
 165   ARM_USBH_Uninitialize,
 166   ARM_USBH_PowerControl,
 167   ARM_USBH_PortVbusOnOff,
 168   ARM_USBH_PortReset,
 169   ARM_USBH_PortSuspend,
 170   ARM_USBH_PortResume,
 171   ARM_USBH_PortGetState,
 172   ARM_USBH_PipeCreate,
 173   ARM_USBH_PipeModify,
 174   ARM_USBH_PipeDelete,
 175   ARM_USBH_PipeReset,
 176   ARM_USBH_PipeTransfer,
 177   ARM_USBH_PipeTransferGetResult,
 178   ARM_USBH_PipeTransferAbort,
 179   ARM_USBH_GetFrameNumber
 180 };
 181