• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2022-2023 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 OHOS_HDI_USB_V1_2_USBIMPL_H
17 #define OHOS_HDI_USB_V1_2_USBIMPL_H
18 
19 #include <map>
20 #include <mutex>
21 
22 #include "hdf_slist.h"
23 #include "hdf_usb_pnp_manage.h"
24 #include "iproxy_broker.h"
25 #include "iremote_object.h"
26 #include "osal_mutex.h"
27 #include "usb_session.h"
28 #include "usbd.h"
29 #include "usbd_load_usb_service.h"
30 #include "v1_2/iusb_interface.h"
31 
32 #define BASE_CLASS_HUB 0x09
33 
34 constexpr uint8_t MAX_INTERFACEID = 0xFF;
35 
36 namespace OHOS {
37 namespace HDI {
38 namespace Usb {
39 namespace V1_2 {
40 class UsbImpl : public OHOS::HDI::Usb::V1_2::IUsbInterface {
41 public:
42     OsalMutex lock_;
43     HdfSList devList_;
44     UsbSession *session_;
45     HdfDeviceObject *device_;
46 
47     UsbImpl();
48     ~UsbImpl() override;
49     int32_t OpenDevice(const UsbDev &dev) override;
50     int32_t CloseDevice(const UsbDev &dev) override;
51     int32_t ResetDevice(const UsbDev &dev) override;
52     int32_t GetDeviceDescriptor(const UsbDev &dev, std::vector<uint8_t> &decriptor) override;
53     int32_t GetStringDescriptor(const UsbDev &dev, uint8_t descId, std::vector<uint8_t> &decriptor) override;
54     int32_t GetConfigDescriptor(const UsbDev &dev, uint8_t descId, std::vector<uint8_t> &decriptor) override;
55     int32_t GetRawDescriptor(const UsbDev &dev, std::vector<uint8_t> &decriptor) override;
56     int32_t GetFileDescriptor(const UsbDev &dev, int32_t &fd) override;
57     int32_t GetDeviceFileDescriptor(const UsbDev &dev, int32_t &fd) override;
58     int32_t SetConfig(const UsbDev &dev, uint8_t configIndex) override;
59     int32_t GetConfig(const UsbDev &dev, uint8_t &configIndex) override;
60     int32_t ClaimInterface(const UsbDev &dev, uint8_t interfaceId, uint8_t force) override;
61     int32_t ReleaseInterface(const UsbDev &dev, uint8_t interfaceId) override;
62     int32_t ManageInterface(const UsbDev &dev, uint8_t interfaceId, bool disable) override;
63     int32_t SetInterface(const UsbDev &dev, uint8_t interfaceId, uint8_t altIndex) override;
64     int32_t BulkTransferRead(
65         const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector<uint8_t> &data) override;
66     int32_t BulkTransferReadwithLength(const UsbDev &dev,
67         const UsbPipe &pipe, int32_t timeout, int32_t length, std::vector<uint8_t> &data) override;
68     int32_t BulkTransferWrite(
69         const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, const std::vector<uint8_t> &data) override;
70     int32_t ControlTransferRead(const UsbDev &dev, const UsbCtrlTransfer &ctrl, std::vector<uint8_t> &data) override;
71     int32_t ControlTransferWrite(
72         const UsbDev &dev, const UsbCtrlTransfer &ctrl, const std::vector<uint8_t> &data) override;
73     int32_t ControlTransferReadwithLength(
74         const UsbDev &dev, const UsbCtrlTransferParams &ctrlParams, std::vector<uint8_t> &data) override;
75     int32_t InterruptTransferRead(
76         const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector<uint8_t> &data) override;
77     int32_t InterruptTransferWrite(
78         const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, const std::vector<uint8_t> &data) override;
79     int32_t IsoTransferRead(
80         const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, std::vector<uint8_t> &data) override;
81     int32_t IsoTransferWrite(
82         const UsbDev &dev, const UsbPipe &pipe, int32_t timeout, const std::vector<uint8_t> &data) override;
83     int32_t RequestQueue(const UsbDev &dev, const UsbPipe &pipe, const std::vector<uint8_t> &clientData,
84         const std::vector<uint8_t> &buffer) override;
85     int32_t RequestWait(
86         const UsbDev &dev, std::vector<uint8_t> &clientData, std::vector<uint8_t> &buffer, int32_t timeout) override;
87     int32_t RequestCancel(const UsbDev &dev, const UsbPipe &pipe) override;
88     int32_t GetCurrentFunctions(int32_t &funcs) override;
89     int32_t SetCurrentFunctions(int32_t funcs) override;
90     int32_t SetPortRole(int32_t portId, int32_t powerRole, int32_t dataRole) override;
91     int32_t QueryPort(int32_t &portId, int32_t &powerRole, int32_t &dataRole, int32_t &mode) override;
92     int32_t BindUsbdSubscriber(const sptr<IUsbdSubscriber> &subscriber) override;
93     int32_t UnbindUsbdSubscriber(const sptr<IUsbdSubscriber> &subscriber) override;
94     int32_t RegBulkCallback(const UsbDev &dev, const UsbPipe &pipe, const sptr<IUsbdBulkCallback> &cb) override;
95     int32_t UnRegBulkCallback(const UsbDev &dev, const UsbPipe &pipe) override;
96     int32_t BulkRead(const UsbDev &dev, const UsbPipe &pipe, const sptr<Ashmem> &ashmem) override;
97     int32_t BulkWrite(const UsbDev &dev, const UsbPipe &pipe, const sptr<Ashmem> &ashmem) override;
98     int32_t BulkCancel(const UsbDev &dev, const UsbPipe &pipe) override;
99     int32_t UsbSubmitTransfer(const UsbDev &dev, const OHOS::HDI::Usb::V1_2::USBTransferInfo &info,
100         const sptr<OHOS::HDI::Usb::V1_2::IUsbdTransferCallback> &cb, const sptr<Ashmem> &ashmem) override;
101     int32_t UsbCancelTransfer(const UsbDev &dev, const int32_t endpoint) override;
102     int32_t ClearHalt(const UsbDev &dev, const UsbPipe &pipe) override;
103 
104     static int32_t UsbdRequestSyncReleaseList(HostDevice *port);
105     static int32_t UsbdRequestASyncReleaseList(HostDevice *port);
106 
107     static int32_t UsbdBulkASyncListReleasePort(HostDevice *port);
108     static int32_t UsbdRequestASyncReleaseData(UsbdRequestASync *request);
109     static UsbInterfaceHandle *InterfaceIdToHandle(const HostDevice *dev, uint8_t id);
110     static void UpdateFunctionStatus();
111     static int32_t UsbdEventHandle(const sptr<UsbImpl> &inst);
112     static int32_t UsbdEventHandleRelease(void);
113 
114     HostDevice *FindDevFromService(uint8_t busNum, uint8_t devAddr);
115     int32_t GetInterfaceActiveStatus(const UsbDev &dev, uint8_t interfaceId, bool &unactivated) override;
116     int32_t GetDeviceSpeed(const UsbDev &dev, uint8_t &speed) override;
117     int32_t GetAccessoryInfo(std::vector<std::string> &accessoryInfo) override;
118     int32_t OpenAccessory(int32_t &fd) override;
119     int32_t CloseAccessory(int32_t fd) override;
120 
121 private:
122     int32_t IfConfigIndex(const uint8_t configIndex, HostDevice *port, int32_t &ret);
123     void MakeUsbControlParams(
124         UsbControlParams *controlParams, uint8_t *buffer, uint16_t length, uint16_t value, uint16_t index);
125     void MakeGetActiveUsbControlParams(
126         UsbControlParams *controlParams, uint8_t *buffer, uint16_t length, uint16_t value, uint16_t index);
127     int32_t UsbControlTransferEx(HostDevice *dev, UsbControlParams *ctrParams, int32_t timeout);
128     void MakeSetActiveUsbControlParams(
129         UsbControlParams *controlParams, uint8_t *buffer, uint16_t length, uint16_t value, uint16_t index);
130     static int32_t ReOpenDevice(HostDevice *port);
131     int32_t UsbdFindRequestSyncAndCreat(
132         HostDevice *port, uint8_t interfaceId, uint8_t pipeAddr, UsbdRequestSync **request);
133     int32_t UsbdFindRequestSyncAndCreatwithLength(HostDevice *port, uint8_t interfaceId,
134         uint8_t pipeAddr, int32_t length, UsbdRequestSync **request);
135     int32_t UsbdBulkReadSyncBase(
136         int32_t timeout, uint8_t *buffer, uint32_t size, uint32_t *actlength, UsbdRequestSync *requestSync);
137     int32_t UsbdBulkWriteSyncBase(
138         HostDevice *port, UsbdRequestSync *requestSync, const uint8_t *buffer, uint32_t length, int32_t timeout);
139     UsbdRequestASync *UsbdFindRequestASync(HostDevice *port, uint8_t interfaceId, uint8_t pipeAddr);
140     int32_t FunRequestQueueFillAndSubmit(
141         HostDevice *port, UsbdRequestASync *reqAsync, const uint8_t *buffer, uint32_t length);
142     int32_t GetRequestMsgFromQueue(HostDevice *port, UsbdRequestASync **reqMsg);
143     int32_t GetRequestMsgData(
144         HostDevice *port, UsbdRequestASync *reqMsg, int32_t timeout, uint8_t **buffer, uint32_t *length);
145     int32_t ReleaseInterfaceByPort(HostDevice *port, uint8_t interfaceId);
146     int32_t BindUsbSubscriber(const sptr<IUsbdSubscriber> &subscriber);
147 
148     UsbdBulkASyncList *UsbdBulkASyncListInit(HostDevice *port, uint8_t ifId, uint8_t epId);
149     UsbdBulkASyncList *UsbdBulkASyncListFind(HostDevice *port, uint8_t ifId, uint8_t epId);
150     int32_t InitAsmBufferHandle(UsbdBufferHandle *handle, int32_t fd, int32_t size);
151     int32_t UsbdBulkReadASyncSubmitStart(UsbdBulkASyncList *list);
152     int32_t UsbdBulkASyncWriteSubmitStart(UsbdBulkASyncList *list);
153     void ReleaseAsmBufferHandle(UsbdBufferHandle *handle);
154     int32_t BulkRequestCancel(UsbdBulkASyncList *list);
155     int32_t HdfReadDevice(int32_t *count, int32_t *size, HdfSBuf *reply);
156     int32_t UsbdReleaseDevices();
157     static void ReportUsbdSysEvent(int32_t code, UsbPnpNotifyMatchInfoTable *infoTable,
158         const std::string &operationType);
159     static void UsbdCloseFd(UsbImpl *super, UsbPnpNotifyMatchInfoTable *infoTable);
160     static int32_t UsbdPnpNotifyAddAndRemoveDevice(HdfSBuf *data, UsbdSubscriber *usbdSubscriber, uint32_t id);
161     static int32_t UsbdPnpLoaderEventReceived(void *priv, uint32_t id, HdfSBuf *data);
162     static int32_t UsbdLoadServiceCallback(void *priv, uint32_t id, HdfSBuf *data);
163     class UsbDeathRecipient : public IRemoteObject::DeathRecipient {
164     public:
UsbDeathRecipient(const sptr<IUsbdSubscriber> & deathSubscriber)165         explicit UsbDeathRecipient(const sptr<IUsbdSubscriber> &deathSubscriber) : deathSubscriber_(deathSubscriber) {};
~UsbDeathRecipient()166         ~UsbDeathRecipient() override {};
167         void OnRemoteDied(const wptr<IRemoteObject> &object) override;
168 
169     private:
170         sptr<IUsbdSubscriber> deathSubscriber_;
171     };
172 
173     class UsbAsyncTransferDeathRecipient : public IRemoteObject::DeathRecipient {
174     public:
UsbAsyncTransferDeathRecipient(const UsbDev & dev,const int32_t endpoint,UsbImpl * usbImpl,const sptr<IRemoteObject> remote)175         explicit UsbAsyncTransferDeathRecipient(const UsbDev &dev, const int32_t endpoint,
176             UsbImpl *usbImpl, const sptr<IRemoteObject> remote)
177             : dev_(dev), endpoint_(endpoint), usbImpl_(usbImpl), remote_(remote) {};
~UsbAsyncTransferDeathRecipient()178         ~UsbAsyncTransferDeathRecipient() {};
179         void OnRemoteDied(const wptr<IRemoteObject> &object) override;
180     private:
181         const UsbDev dev_;
182         const int32_t endpoint_;
183         UsbImpl *usbImpl_;
184         const sptr<IRemoteObject> remote_;
185     };
186 
187     void parsePortPath();
188 
189 private:
190     static HdfDevEventlistener listenerForLoadService_;
191     static UsbdSubscriber subscribers_[MAX_SUBSCRIBER];
192     static bool isGadgetConnected_;
193     static uint32_t attachCount_;
194     static uint32_t attachFailedCount_;
195     static UsbdLoadService loadUsbService_;
196     static UsbdLoadService loadHdfEdm_;
197     std::mutex openedFdsMutex_;
198     std::map<std::pair<uint8_t, uint8_t>, int32_t> openedFds_;
199 };
200 } // namespace V1_2
201 } // namespace Usb
202 } // namespace HDI
203 } // namespace OHOS
204 #endif // OHOS_HDI_USB_V1_2_USBIMPL_H
205