• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-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 USBMGR_INNERKITS_IUSB_SRV_H
17 #define USBMGR_INNERKITS_IUSB_SRV_H
18 
19 #include "iremote_broker.h"
20 #include "iremote_object.h"
21 #include "usb_device.h"
22 #include "usb_port.h"
23 #include "v1_0/usb_types.h"
24 #include "usb_interface_type.h"
25 
26 namespace OHOS {
27 namespace USB {
28 class IUsbSrv : public IRemoteBroker {
29 public:
30     virtual int32_t OpenDevice(uint8_t busNum, uint8_t devAddr) = 0;
31     virtual bool HasRight(std::string deviceName) = 0;
32     virtual int32_t RequestRight(std::string deviceName) = 0;
33     virtual int32_t RemoveRight(std::string deviceName) = 0;
34     virtual int32_t GetDevices(std::vector<UsbDevice> &deviceList) = 0;
35     virtual int32_t GetCurrentFunctions(int32_t &funcs) = 0;
36     virtual int32_t SetCurrentFunctions(int32_t funcs) = 0;
37     virtual int32_t UsbFunctionsFromString(std::string_view funcs) = 0;
38     virtual std::string UsbFunctionsToString(int32_t funcs) = 0;
39     virtual int32_t GetPorts(std::vector<UsbPort> &ports) = 0;
40     virtual int32_t GetSupportedModes(int32_t portId, int32_t &supportedModes) = 0;
41     virtual int32_t SetPortRole(int32_t portId, int32_t powerRole, int32_t dataRole) = 0;
42     virtual int32_t ReleaseInterface(uint8_t busNum, uint8_t devAddr, uint8_t interfaceid) = 0;
43     virtual int32_t ClaimInterface(uint8_t busNum, uint8_t devAddr, uint8_t interfaceid, uint8_t force) = 0;
44     virtual int32_t BulkTransferRead(const HDI::Usb::V1_0::UsbDev &dev, const HDI::Usb::V1_0::UsbPipe &pipe,
45         std::vector<uint8_t> &bufferData, int32_t timeOut) = 0;
46     virtual int32_t BulkTransferWrite(const HDI::Usb::V1_0::UsbDev &dev, const HDI::Usb::V1_0::UsbPipe &pipe,
47         const std::vector<uint8_t> &bufferData, int32_t timeOut) = 0;
48     virtual int32_t ControlTransfer(const HDI::Usb::V1_0::UsbDev &dev, const HDI::Usb::V1_0::UsbCtrlTransfer &ctrl,
49         std::vector<uint8_t> &bufferData) = 0;
50     virtual int32_t SetActiveConfig(uint8_t busNum, uint8_t devAddr, uint8_t configId) = 0;
51     virtual int32_t GetActiveConfig(uint8_t busNum, uint8_t devAddr, uint8_t &configId) = 0;
52     virtual int32_t SetInterface(uint8_t busNum, uint8_t devAddr, uint8_t interfaceid, uint8_t altIndex) = 0;
53     virtual int32_t GetRawDescriptor(uint8_t busNum, uint8_t devAddr, std::vector<uint8_t> &bufferData) = 0;
54     virtual int32_t GetFileDescriptor(uint8_t busNum, uint8_t devAddr, int32_t &fd) = 0;
55     virtual int32_t RequestQueue(const HDI::Usb::V1_0::UsbDev &dev, const HDI::Usb::V1_0::UsbPipe &pipe,
56         const std::vector<uint8_t> &clientData, const std::vector<uint8_t> &bufferData) = 0;
57     virtual int32_t RequestWait(const HDI::Usb::V1_0::UsbDev &dev, int32_t timeOut, std::vector<uint8_t> &clientData,
58         std::vector<uint8_t> &bufferData) = 0;
59     virtual int32_t RequestCancel(uint8_t busNum, uint8_t devAddr, uint8_t interfaceid, uint8_t endpointId) = 0;
60     virtual int32_t Close(uint8_t busNum, uint8_t devAddr) = 0;
61 
62     virtual int32_t RegBulkCallback(const HDI::Usb::V1_0::UsbDev &devInfo, const HDI::Usb::V1_0::UsbPipe &pipe,
63         const sptr<IRemoteObject> &cb) = 0;
64     virtual int32_t UnRegBulkCallback(const HDI::Usb::V1_0::UsbDev &devInfo, const HDI::Usb::V1_0::UsbPipe &pipe) = 0;
65     virtual int32_t BulkRead(const HDI::Usb::V1_0::UsbDev &devInfo, const HDI::Usb::V1_0::UsbPipe &pipe,
66         sptr<Ashmem> &ashmem) = 0;
67     virtual int32_t BulkWrite(const HDI::Usb::V1_0::UsbDev &devInfo, const HDI::Usb::V1_0::UsbPipe &pipe,
68         sptr<Ashmem> &ashmem) = 0;
69     virtual int32_t BulkCancel(const HDI::Usb::V1_0::UsbDev &devInfo, const HDI::Usb::V1_0::UsbPipe &pipe) = 0;
70     virtual int32_t AddRight(const std::string &bundleName, const std::string &deviceName) = 0;
71     virtual int32_t ManageGlobalInterface(bool disable) = 0;
72     virtual int32_t ManageDevice(int32_t vendorId, int32_t productId, bool disable) = 0;
73     virtual int32_t ManageInterfaceType(InterfaceType interfaceType, bool disable) = 0;
74 public:
75     DECLARE_INTERFACE_DESCRIPTOR(u"ohos.usb.IUsbSrv");
76 };
77 } // namespace USB
78 } // namespace OHOS
79 
80 #endif // USBMGR_INNERKITS_IUSB_SRV_H
81