1/*
2 * Copyright (c) 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_GADGET_MTP_V1_0_IUSBFNMTPINTERFACE_H
17#define OHOS_HDI_USB_GADGET_MTP_V1_0_IUSBFNMTPINTERFACE_H
18
19#include <stdint.h>
20#include <vector>
21#include <hdf_base.h>
22#include <hdi_base.h>
23#include "usb/gadget/mtp/v1_0/usbfn_mtp_types.h"
24
25#ifndef HDI_BUFF_MAX_SIZE
26#define HDI_BUFF_MAX_SIZE (1024 * 200)
27#endif
28
29#ifndef HDI_CHECK_VALUE_RETURN
30#define HDI_CHECK_VALUE_RETURN(lv, compare, rv, ret) do { \
31    if ((lv) compare (rv)) { \
32        return ret; \
33    } \
34} while (false)
35#endif
36
37#ifndef HDI_CHECK_VALUE_RET_GOTO
38#define HDI_CHECK_VALUE_RET_GOTO(lv, compare, rv, ret, value, table) do { \
39    if ((lv) compare (rv)) { \
40        ret = value; \
41        goto table; \
42    } \
43} while (false)
44#endif
45
46namespace OHOS {
47namespace HDI {
48namespace Usb {
49namespace Gadget {
50namespace Mtp {
51namespace V1_0 {
52using namespace OHOS;
53using namespace OHOS::HDI;
54
55enum {
56    CMD_USBFN_MTP_INTERFACE_GET_VERSION = 0,
57    CMD_USBFN_MTP_INTERFACE_START = 1,
58    CMD_USBFN_MTP_INTERFACE_STOP = 2,
59    CMD_USBFN_MTP_INTERFACE_READ = 3,
60    CMD_USBFN_MTP_INTERFACE_WRITE = 4,
61    CMD_USBFN_MTP_INTERFACE_RECEIVE_FILE = 5,
62    CMD_USBFN_MTP_INTERFACE_SEND_FILE = 6,
63    CMD_USBFN_MTP_INTERFACE_SEND_EVENT = 7,
64    CMD_USBFN_MTP_INTERFACE_INIT = 8,
65    CMD_USBFN_MTP_INTERFACE_RELEASE = 9,
66};
67
68class IUsbfnMtpInterface : public HdiBase {
69public:
70    DECLARE_HDI_DESCRIPTOR(u"ohos.hdi.usb.gadget.mtp.v1_0.IUsbfnMtpInterface");
71
72    virtual ~IUsbfnMtpInterface() = default;
73
74    static sptr<OHOS::HDI::Usb::Gadget::Mtp::V1_0::IUsbfnMtpInterface> Get(bool isStub = false);
75    static sptr<OHOS::HDI::Usb::Gadget::Mtp::V1_0::IUsbfnMtpInterface> Get(const std::string &serviceName, bool isStub = false);
76
77    virtual int32_t Start() = 0;
78
79    virtual int32_t Stop() = 0;
80
81    virtual int32_t Read(std::vector<uint8_t>& data) = 0;
82
83    virtual int32_t Write(const std::vector<uint8_t>& data) = 0;
84
85    virtual int32_t ReceiveFile(const OHOS::HDI::Usb::Gadget::Mtp::V1_0::UsbFnMtpFileSlice& mfs) = 0;
86
87    virtual int32_t SendFile(const OHOS::HDI::Usb::Gadget::Mtp::V1_0::UsbFnMtpFileSlice& mfs) = 0;
88
89    virtual int32_t SendEvent(const std::vector<uint8_t>& eventData) = 0;
90
91    virtual int32_t Init() = 0;
92
93    virtual int32_t Release() = 0;
94
95    virtual int32_t GetVersion(uint32_t& majorVer, uint32_t& minorVer)
96    {
97        majorVer = 1;
98        minorVer = 0;
99        return HDF_SUCCESS;
100    }
101
102    virtual bool IsProxy()
103    {
104        return false;
105    }
106
107    virtual const std::u16string GetDesc()
108    {
109        return metaDescriptor_;
110    }
111};
112} // V1_0
113} // Mtp
114} // Gadget
115} // Usb
116} // HDI
117} // OHOS
118
119#endif // OHOS_HDI_USB_GADGET_MTP_V1_0_IUSBFNMTPINTERFACE_H
120
121