1 /*
2 * Copyright (c) 2021 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #ifndef USB_HOST_LINUX_ADAPTER_H
17 #define USB_HOST_LINUX_ADAPTER_H
18
19 #include "usb_raw_api_library.h"
20
21 #if __GLIBC__ == 2 && __GLIBC_MINOR__ < 30
22 #include <sys/syscall.h>
gettid()23 static inline pid_t gettid()
24 {
25 return syscall(SYS_gettid);
26 }
27 #endif
28
29 #define USBDEV_PATH "/dev"
30 #define USB_DEV_FS_PATH "/dev/bus/usb"
31
32 #define BUS_OFFSET 8
33
34 #define MAX_BULK_DATA_BUFFER_LENGTH 4096
35 #define MAX_BULK_URBS_PER_REQUEST 1
36
37 #define MAX_ISO_PACKETS_PER_URB 128
38 #define MAX_ISO_DATA_BUFFER_LEN (8 * 1024)
39 #define MAX_ISO_URBS_PER_REQUEST (((MAX_ISO_DATA_BUFFER_LEN - 1) / MAX_ISO_PACKETS_PER_URB) + 1)
40
41 #define URBS_PER_REQUEST MAX(MAX_BULK_URBS_PER_REQUEST, MAX_ISO_URBS_PER_REQUEST)
42
43 #define MAX_ISO_SHARE_MEMERY_SIZE sizeof(struct UsbHostRequest) + \
44 (URBS_PER_REQUEST * sizeof(struct UsbAdapterUrb)) + MAX_ISO_DATA_BUFFER_LEN
45 #define MAX_BULK_SHARE_MEMERY_SIZE sizeof(struct UsbHostRequest) + \
46 (URBS_PER_REQUEST * sizeof(struct UsbAdapterUrb)) + MAX_BULK_DATA_BUFFER_LENGTH
47 #define MAX_CTRL_BUFFER_LENGTH 4096
48
49 #define USB_ADAPTER_URB_TYPE_ISO 0
50 #define USB_ADAPTER_URB_TYPE_INTERRUPT 1
51 #define USB_ADAPTER_URB_TYPE_CONTROL 2
52 #define USB_ADAPTER_URB_TYPE_BULK 3
53 #define USB_ADAPTER_URB_SHORT_NOT_OK 0x01
54 #define USB_ADAPTER_URB_ISO_ASAP 0x02
55 #define USB_ADAPTER_URB_BULK_CONTINUATION 0x04
56 #define USB_ADAPTER_URB_QUEUE_BULK 0x10
57 #define USB_ADAPTER_URB_ZERO_PACKET 0x40
58 #define USB_ADAPTER_CAP_ZERO_PACKET 0x01
59 #define USB_ADAPTER_CAP_BULK_CONTINUATION 0x02
60 #define USB_ADAPTER_CAP_NO_PACKET_SIZE_LIM 0x04
61 #define USB_ADAPTER_CAP_BULK_SCATTER_GATHER 0x08
62 #define USB_ADAPTER_CAP_REAP_AFTER_DISCONNECT 0x10
63
64 #define USBDEVFS_CONTROL _IOWR('U', 0, struct UsbControlRequestData)
65 #define USBDEVFS_SETINTERFACE _IOR('U', 4, struct UsbAdapterSetInterface)
66 #define USBDEVFS_SETCONFIGURATION _IOR('U', 5, unsigned int)
67 #define USBDEVFS_SUBMITURB _IOR('U', 10, struct UsbAdapterUrb)
68 #define USBDEVFS_DISCARDURB _IO('U', 11)
69 #define USBDEVFS_REAPURB _IOW('U', 12, void *)
70 #define USBDEVFS_CLAIMINTERFACE _IOR('U', 15, unsigned int)
71 #define USBDEVFS_RELEASEINTERFACE _IOR('U', 16, unsigned int)
72 #define USBDEVFS_RESET _IO('U', 20)
73 #define USBDEVFS_CLEAR_HALT _IOR('U', 21, unsigned int)
74 #define USBDEVFS_GET_CAPABILITIES _IOR('U', 26, unsigned int)
75 #define USBDEVFS_ALLOC_STREAMS _IOR('U', 28, struct UsbAdapterStreams)
76 #define USBDEVFS_FREE_STREAMS _IOR('U', 29, struct UsbAdapterStreams)
77
78 struct UsbAdapterSetInterface {
79 unsigned int interface;
80 unsigned int altSetting;
81 };
82
83 struct UsbAdapterStreams {
84 unsigned int numStreams;
85 unsigned int numEps;
86 unsigned char eps[0];
87 };
88
89 struct UsbOsAdapterOps {
90 int (*init)(const struct UsbSession *session);
91 void (*exit)(const struct UsbSession *session);
92 struct UsbDeviceHandle *(*openDevice)(struct UsbSession *session, uint8_t busNum, uint8_t usbAddr);
93 void (*closeDevice)(struct UsbDeviceHandle *devHandle);
94 int (*getConfigDescriptor)(const struct UsbDevice *device, uint8_t configIndex, void *buffer, size_t len);
95 int (*getConfiguration)(const struct UsbDeviceHandle *devHandle, uint8_t *activeConfig);
96 int (*setConfiguration)(struct UsbDeviceHandle *devHandle, int activeConfig);
97 int (*claimInterface)(const struct UsbDeviceHandle *devHandle, unsigned int interfaceNumber);
98 int (*releaseInterface)(const struct UsbDeviceHandle *devHandle, unsigned int interfaceNumber);
99 int (*setInterfaceAltsetting)(const struct UsbDeviceHandle *devHandle, uint8_t interfaceNumber, uint8_t altsetting);
100 int (*clearHalt)(const struct UsbDeviceHandle *devHandle, unsigned int endpoint);
101 int (*resetDevice)(const struct UsbDeviceHandle *devHandle);
102 struct UsbHostRequest *(*allocRequest)(const struct UsbDeviceHandle *handle, int isoPackets, size_t len);
103 int (*freeRequest)(struct UsbHostRequest *request);
104 int (*submitRequest)(struct UsbHostRequest *request);
105 int (*cancelRequest)(struct UsbHostRequest *request);
106 int (*urbCompleteHandle)(const struct UsbDeviceHandle *devHandle);
107 };
108
109 struct UsbOsAdapterOps *UsbAdapterGetOps(void);
110 UsbRawTidType UsbAdapterGetTid(void);
111 int UsbAdapterRegisterSignal(void);
112 int UsbAdapterKillSignal(struct UsbDeviceHandle *devHandle, UsbRawTidType tid);
113 int AdapterAtomicInc(OsalAtomic *v);
114 int AdapterAtomicDec(OsalAtomic *v);
115
116 #endif /* USB_HOST_LINUX_ADAPTER_H */
117