xref: /aosp_15_r20/hardware/interfaces/usb/gadget/1.1/default/UsbGadget.cpp (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1*4d7e907cSAndroid Build Coastguard Worker /*
2*4d7e907cSAndroid Build Coastguard Worker  * Copyright (C) 2020 The Android Open Source Project
3*4d7e907cSAndroid Build Coastguard Worker  *
4*4d7e907cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*4d7e907cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*4d7e907cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*4d7e907cSAndroid Build Coastguard Worker  *
8*4d7e907cSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*4d7e907cSAndroid Build Coastguard Worker  *
10*4d7e907cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*4d7e907cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*4d7e907cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4d7e907cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*4d7e907cSAndroid Build Coastguard Worker  * limitations under the License.
15*4d7e907cSAndroid Build Coastguard Worker  */
16*4d7e907cSAndroid Build Coastguard Worker 
17*4d7e907cSAndroid Build Coastguard Worker #define LOG_TAG "[email protected]"
18*4d7e907cSAndroid Build Coastguard Worker 
19*4d7e907cSAndroid Build Coastguard Worker #include "UsbGadget.h"
20*4d7e907cSAndroid Build Coastguard Worker #include <dirent.h>
21*4d7e907cSAndroid Build Coastguard Worker #include <fcntl.h>
22*4d7e907cSAndroid Build Coastguard Worker #include <stdio.h>
23*4d7e907cSAndroid Build Coastguard Worker #include <sys/inotify.h>
24*4d7e907cSAndroid Build Coastguard Worker #include <sys/mount.h>
25*4d7e907cSAndroid Build Coastguard Worker #include <sys/stat.h>
26*4d7e907cSAndroid Build Coastguard Worker #include <sys/types.h>
27*4d7e907cSAndroid Build Coastguard Worker #include <unistd.h>
28*4d7e907cSAndroid Build Coastguard Worker 
29*4d7e907cSAndroid Build Coastguard Worker namespace android {
30*4d7e907cSAndroid Build Coastguard Worker namespace hardware {
31*4d7e907cSAndroid Build Coastguard Worker namespace usb {
32*4d7e907cSAndroid Build Coastguard Worker namespace gadget {
33*4d7e907cSAndroid Build Coastguard Worker namespace V1_1 {
34*4d7e907cSAndroid Build Coastguard Worker namespace implementation {
35*4d7e907cSAndroid Build Coastguard Worker 
UsbGadget()36*4d7e907cSAndroid Build Coastguard Worker UsbGadget::UsbGadget() {
37*4d7e907cSAndroid Build Coastguard Worker     if (access(OS_DESC_PATH, R_OK) != 0) {
38*4d7e907cSAndroid Build Coastguard Worker         ALOGE("configfs setup not done yet");
39*4d7e907cSAndroid Build Coastguard Worker         abort();
40*4d7e907cSAndroid Build Coastguard Worker     }
41*4d7e907cSAndroid Build Coastguard Worker }
42*4d7e907cSAndroid Build Coastguard Worker 
currentFunctionsAppliedCallback(bool functionsApplied,void * payload)43*4d7e907cSAndroid Build Coastguard Worker void currentFunctionsAppliedCallback(bool functionsApplied, void* payload) {
44*4d7e907cSAndroid Build Coastguard Worker     UsbGadget* gadget = (UsbGadget*)payload;
45*4d7e907cSAndroid Build Coastguard Worker     gadget->mCurrentUsbFunctionsApplied = functionsApplied;
46*4d7e907cSAndroid Build Coastguard Worker }
47*4d7e907cSAndroid Build Coastguard Worker 
getCurrentUsbFunctions(const sp<V1_0::IUsbGadgetCallback> & callback)48*4d7e907cSAndroid Build Coastguard Worker Return<void> UsbGadget::getCurrentUsbFunctions(const sp<V1_0::IUsbGadgetCallback>& callback) {
49*4d7e907cSAndroid Build Coastguard Worker     Return<void> ret = callback->getCurrentUsbFunctionsCb(
50*4d7e907cSAndroid Build Coastguard Worker             mCurrentUsbFunctions, mCurrentUsbFunctionsApplied ? Status::FUNCTIONS_APPLIED
51*4d7e907cSAndroid Build Coastguard Worker                                                               : Status::FUNCTIONS_NOT_APPLIED);
52*4d7e907cSAndroid Build Coastguard Worker     if (!ret.isOk()) ALOGE("Call to getCurrentUsbFunctionsCb failed %s", ret.description().c_str());
53*4d7e907cSAndroid Build Coastguard Worker 
54*4d7e907cSAndroid Build Coastguard Worker     return Void();
55*4d7e907cSAndroid Build Coastguard Worker }
56*4d7e907cSAndroid Build Coastguard Worker 
tearDownGadget()57*4d7e907cSAndroid Build Coastguard Worker V1_0::Status UsbGadget::tearDownGadget() {
58*4d7e907cSAndroid Build Coastguard Worker     if (resetGadget() != V1_0::Status::SUCCESS) return V1_0::Status::ERROR;
59*4d7e907cSAndroid Build Coastguard Worker 
60*4d7e907cSAndroid Build Coastguard Worker     if (monitorFfs.isMonitorRunning()) {
61*4d7e907cSAndroid Build Coastguard Worker         monitorFfs.reset();
62*4d7e907cSAndroid Build Coastguard Worker     } else {
63*4d7e907cSAndroid Build Coastguard Worker         ALOGI("mMonitor not running");
64*4d7e907cSAndroid Build Coastguard Worker     }
65*4d7e907cSAndroid Build Coastguard Worker     return V1_0::Status::SUCCESS;
66*4d7e907cSAndroid Build Coastguard Worker }
67*4d7e907cSAndroid Build Coastguard Worker 
reset()68*4d7e907cSAndroid Build Coastguard Worker Return<Status> UsbGadget::reset() {
69*4d7e907cSAndroid Build Coastguard Worker     if (!WriteStringToFile("none", PULLUP_PATH)) {
70*4d7e907cSAndroid Build Coastguard Worker         ALOGI("Gadget cannot be pulled down");
71*4d7e907cSAndroid Build Coastguard Worker         return Status::ERROR;
72*4d7e907cSAndroid Build Coastguard Worker     }
73*4d7e907cSAndroid Build Coastguard Worker 
74*4d7e907cSAndroid Build Coastguard Worker     return Status::SUCCESS;
75*4d7e907cSAndroid Build Coastguard Worker }
76*4d7e907cSAndroid Build Coastguard Worker 
validateAndSetVidPid(uint64_t functions)77*4d7e907cSAndroid Build Coastguard Worker static V1_0::Status validateAndSetVidPid(uint64_t functions) {
78*4d7e907cSAndroid Build Coastguard Worker     V1_0::Status ret = V1_0::Status::SUCCESS;
79*4d7e907cSAndroid Build Coastguard Worker 
80*4d7e907cSAndroid Build Coastguard Worker     switch (functions) {
81*4d7e907cSAndroid Build Coastguard Worker         case static_cast<uint64_t>(V1_0::GadgetFunction::MTP):
82*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee1");
83*4d7e907cSAndroid Build Coastguard Worker             break;
84*4d7e907cSAndroid Build Coastguard Worker         case V1_0::GadgetFunction::ADB | V1_0::GadgetFunction::MTP:
85*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee2");
86*4d7e907cSAndroid Build Coastguard Worker             break;
87*4d7e907cSAndroid Build Coastguard Worker         case static_cast<uint64_t>(V1_0::GadgetFunction::RNDIS):
88*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee3");
89*4d7e907cSAndroid Build Coastguard Worker             break;
90*4d7e907cSAndroid Build Coastguard Worker         case V1_0::GadgetFunction::ADB | V1_0::GadgetFunction::RNDIS:
91*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee4");
92*4d7e907cSAndroid Build Coastguard Worker             break;
93*4d7e907cSAndroid Build Coastguard Worker         case static_cast<uint64_t>(V1_0::GadgetFunction::PTP):
94*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee5");
95*4d7e907cSAndroid Build Coastguard Worker             break;
96*4d7e907cSAndroid Build Coastguard Worker         case V1_0::GadgetFunction::ADB | V1_0::GadgetFunction::PTP:
97*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee6");
98*4d7e907cSAndroid Build Coastguard Worker             break;
99*4d7e907cSAndroid Build Coastguard Worker         case static_cast<uint64_t>(V1_0::GadgetFunction::ADB):
100*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee7");
101*4d7e907cSAndroid Build Coastguard Worker             break;
102*4d7e907cSAndroid Build Coastguard Worker         case static_cast<uint64_t>(V1_0::GadgetFunction::MIDI):
103*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee8");
104*4d7e907cSAndroid Build Coastguard Worker             break;
105*4d7e907cSAndroid Build Coastguard Worker         case V1_0::GadgetFunction::ADB | V1_0::GadgetFunction::MIDI:
106*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x4ee9");
107*4d7e907cSAndroid Build Coastguard Worker             break;
108*4d7e907cSAndroid Build Coastguard Worker         case static_cast<uint64_t>(V1_0::GadgetFunction::ACCESSORY):
109*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x2d00");
110*4d7e907cSAndroid Build Coastguard Worker             break;
111*4d7e907cSAndroid Build Coastguard Worker         case V1_0::GadgetFunction::ADB | V1_0::GadgetFunction::ACCESSORY:
112*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x2d01");
113*4d7e907cSAndroid Build Coastguard Worker             break;
114*4d7e907cSAndroid Build Coastguard Worker         case static_cast<uint64_t>(V1_0::GadgetFunction::AUDIO_SOURCE):
115*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x2d02");
116*4d7e907cSAndroid Build Coastguard Worker             break;
117*4d7e907cSAndroid Build Coastguard Worker         case V1_0::GadgetFunction::ADB | V1_0::GadgetFunction::AUDIO_SOURCE:
118*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x2d03");
119*4d7e907cSAndroid Build Coastguard Worker             break;
120*4d7e907cSAndroid Build Coastguard Worker         case V1_0::GadgetFunction::ACCESSORY | V1_0::GadgetFunction::AUDIO_SOURCE:
121*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x2d04");
122*4d7e907cSAndroid Build Coastguard Worker             break;
123*4d7e907cSAndroid Build Coastguard Worker         case V1_0::GadgetFunction::ADB | V1_0::GadgetFunction::ACCESSORY |
124*4d7e907cSAndroid Build Coastguard Worker                 V1_0::GadgetFunction::AUDIO_SOURCE:
125*4d7e907cSAndroid Build Coastguard Worker             ret = setVidPid("0x18d1", "0x2d05");
126*4d7e907cSAndroid Build Coastguard Worker             break;
127*4d7e907cSAndroid Build Coastguard Worker         default:
128*4d7e907cSAndroid Build Coastguard Worker             ALOGE("Combination not supported");
129*4d7e907cSAndroid Build Coastguard Worker             ret = V1_0::Status::CONFIGURATION_NOT_SUPPORTED;
130*4d7e907cSAndroid Build Coastguard Worker     }
131*4d7e907cSAndroid Build Coastguard Worker     return ret;
132*4d7e907cSAndroid Build Coastguard Worker }
133*4d7e907cSAndroid Build Coastguard Worker 
setupFunctions(uint64_t functions,const sp<V1_0::IUsbGadgetCallback> & callback,uint64_t timeout)134*4d7e907cSAndroid Build Coastguard Worker V1_0::Status UsbGadget::setupFunctions(uint64_t functions,
135*4d7e907cSAndroid Build Coastguard Worker                                        const sp<V1_0::IUsbGadgetCallback>& callback,
136*4d7e907cSAndroid Build Coastguard Worker                                        uint64_t timeout) {
137*4d7e907cSAndroid Build Coastguard Worker     bool ffsEnabled = false;
138*4d7e907cSAndroid Build Coastguard Worker     int i = 0;
139*4d7e907cSAndroid Build Coastguard Worker 
140*4d7e907cSAndroid Build Coastguard Worker     if (addGenericAndroidFunctions(&monitorFfs, functions, &ffsEnabled, &i) !=
141*4d7e907cSAndroid Build Coastguard Worker         V1_0::Status::SUCCESS)
142*4d7e907cSAndroid Build Coastguard Worker         return V1_0::Status::ERROR;
143*4d7e907cSAndroid Build Coastguard Worker 
144*4d7e907cSAndroid Build Coastguard Worker     if ((functions & V1_0::GadgetFunction::ADB) != 0) {
145*4d7e907cSAndroid Build Coastguard Worker         ffsEnabled = true;
146*4d7e907cSAndroid Build Coastguard Worker         if (addAdb(&monitorFfs, &i) != V1_0::Status::SUCCESS) return V1_0::Status::ERROR;
147*4d7e907cSAndroid Build Coastguard Worker     }
148*4d7e907cSAndroid Build Coastguard Worker 
149*4d7e907cSAndroid Build Coastguard Worker     // Pull up the gadget right away when there are no ffs functions.
150*4d7e907cSAndroid Build Coastguard Worker     if (!ffsEnabled) {
151*4d7e907cSAndroid Build Coastguard Worker         if (!WriteStringToFile(kGadgetName, PULLUP_PATH)) return V1_0::Status::ERROR;
152*4d7e907cSAndroid Build Coastguard Worker         mCurrentUsbFunctionsApplied = true;
153*4d7e907cSAndroid Build Coastguard Worker         if (callback) callback->setCurrentUsbFunctionsCb(functions, V1_0::Status::SUCCESS);
154*4d7e907cSAndroid Build Coastguard Worker         return V1_0::Status::SUCCESS;
155*4d7e907cSAndroid Build Coastguard Worker     }
156*4d7e907cSAndroid Build Coastguard Worker 
157*4d7e907cSAndroid Build Coastguard Worker     monitorFfs.registerFunctionsAppliedCallback(&currentFunctionsAppliedCallback, this);
158*4d7e907cSAndroid Build Coastguard Worker     // Monitors the ffs paths to pull up the gadget when descriptors are written.
159*4d7e907cSAndroid Build Coastguard Worker     // Also takes of the pulling up the gadget again if the userspace process
160*4d7e907cSAndroid Build Coastguard Worker     // dies and restarts.
161*4d7e907cSAndroid Build Coastguard Worker     monitorFfs.startMonitor();
162*4d7e907cSAndroid Build Coastguard Worker 
163*4d7e907cSAndroid Build Coastguard Worker     if (kDebug) ALOGI("Mainthread in Cv");
164*4d7e907cSAndroid Build Coastguard Worker 
165*4d7e907cSAndroid Build Coastguard Worker     if (callback) {
166*4d7e907cSAndroid Build Coastguard Worker         bool pullup = monitorFfs.waitForPullUp(timeout);
167*4d7e907cSAndroid Build Coastguard Worker         Return<void> ret = callback->setCurrentUsbFunctionsCb(
168*4d7e907cSAndroid Build Coastguard Worker                 functions, pullup ? V1_0::Status::SUCCESS : V1_0::Status::ERROR);
169*4d7e907cSAndroid Build Coastguard Worker         if (!ret.isOk()) ALOGE("setCurrentUsbFunctionsCb error %s", ret.description().c_str());
170*4d7e907cSAndroid Build Coastguard Worker     }
171*4d7e907cSAndroid Build Coastguard Worker 
172*4d7e907cSAndroid Build Coastguard Worker     return V1_0::Status::SUCCESS;
173*4d7e907cSAndroid Build Coastguard Worker }
174*4d7e907cSAndroid Build Coastguard Worker 
setCurrentUsbFunctions(uint64_t functions,const sp<V1_0::IUsbGadgetCallback> & callback,uint64_t timeout)175*4d7e907cSAndroid Build Coastguard Worker Return<void> UsbGadget::setCurrentUsbFunctions(uint64_t functions,
176*4d7e907cSAndroid Build Coastguard Worker                                                const sp<V1_0::IUsbGadgetCallback>& callback,
177*4d7e907cSAndroid Build Coastguard Worker                                                uint64_t timeout) {
178*4d7e907cSAndroid Build Coastguard Worker     std::unique_lock<std::mutex> lk(mLockSetCurrentFunction);
179*4d7e907cSAndroid Build Coastguard Worker 
180*4d7e907cSAndroid Build Coastguard Worker     mCurrentUsbFunctions = functions;
181*4d7e907cSAndroid Build Coastguard Worker     mCurrentUsbFunctionsApplied = false;
182*4d7e907cSAndroid Build Coastguard Worker 
183*4d7e907cSAndroid Build Coastguard Worker     // Unlink the gadget and stop the monitor if running.
184*4d7e907cSAndroid Build Coastguard Worker     V1_0::Status status = tearDownGadget();
185*4d7e907cSAndroid Build Coastguard Worker     if (status != V1_0::Status::SUCCESS) {
186*4d7e907cSAndroid Build Coastguard Worker         goto error;
187*4d7e907cSAndroid Build Coastguard Worker     }
188*4d7e907cSAndroid Build Coastguard Worker 
189*4d7e907cSAndroid Build Coastguard Worker     ALOGI("Returned from tearDown gadget");
190*4d7e907cSAndroid Build Coastguard Worker 
191*4d7e907cSAndroid Build Coastguard Worker     // Leave the gadget pulled down to give time for the host to sense disconnect.
192*4d7e907cSAndroid Build Coastguard Worker     usleep(kDisconnectWaitUs);
193*4d7e907cSAndroid Build Coastguard Worker 
194*4d7e907cSAndroid Build Coastguard Worker     if (functions == static_cast<uint64_t>(V1_0::GadgetFunction::NONE)) {
195*4d7e907cSAndroid Build Coastguard Worker         if (callback == NULL) return Void();
196*4d7e907cSAndroid Build Coastguard Worker         Return<void> ret = callback->setCurrentUsbFunctionsCb(functions, V1_0::Status::SUCCESS);
197*4d7e907cSAndroid Build Coastguard Worker         if (!ret.isOk())
198*4d7e907cSAndroid Build Coastguard Worker             ALOGE("Error while calling setCurrentUsbFunctionsCb %s", ret.description().c_str());
199*4d7e907cSAndroid Build Coastguard Worker         return Void();
200*4d7e907cSAndroid Build Coastguard Worker     }
201*4d7e907cSAndroid Build Coastguard Worker 
202*4d7e907cSAndroid Build Coastguard Worker     status = validateAndSetVidPid(functions);
203*4d7e907cSAndroid Build Coastguard Worker 
204*4d7e907cSAndroid Build Coastguard Worker     if (status != V1_0::Status::SUCCESS) {
205*4d7e907cSAndroid Build Coastguard Worker         goto error;
206*4d7e907cSAndroid Build Coastguard Worker     }
207*4d7e907cSAndroid Build Coastguard Worker 
208*4d7e907cSAndroid Build Coastguard Worker     status = setupFunctions(functions, callback, timeout);
209*4d7e907cSAndroid Build Coastguard Worker     if (status != V1_0::Status::SUCCESS) {
210*4d7e907cSAndroid Build Coastguard Worker         goto error;
211*4d7e907cSAndroid Build Coastguard Worker     }
212*4d7e907cSAndroid Build Coastguard Worker 
213*4d7e907cSAndroid Build Coastguard Worker     ALOGI("Usb Gadget setcurrent functions called successfully");
214*4d7e907cSAndroid Build Coastguard Worker     return Void();
215*4d7e907cSAndroid Build Coastguard Worker 
216*4d7e907cSAndroid Build Coastguard Worker error:
217*4d7e907cSAndroid Build Coastguard Worker     ALOGI("Usb Gadget setcurrent functions failed");
218*4d7e907cSAndroid Build Coastguard Worker     if (callback == NULL) return Void();
219*4d7e907cSAndroid Build Coastguard Worker     Return<void> ret = callback->setCurrentUsbFunctionsCb(functions, status);
220*4d7e907cSAndroid Build Coastguard Worker     if (!ret.isOk())
221*4d7e907cSAndroid Build Coastguard Worker         ALOGE("Error while calling setCurrentUsbFunctionsCb %s", ret.description().c_str());
222*4d7e907cSAndroid Build Coastguard Worker     return Void();
223*4d7e907cSAndroid Build Coastguard Worker }
224*4d7e907cSAndroid Build Coastguard Worker }  // namespace implementation
225*4d7e907cSAndroid Build Coastguard Worker }  // namespace V1_1
226*4d7e907cSAndroid Build Coastguard Worker }  // namespace gadget
227*4d7e907cSAndroid Build Coastguard Worker }  // namespace usb
228*4d7e907cSAndroid Build Coastguard Worker }  // namespace hardware
229*4d7e907cSAndroid Build Coastguard Worker }  // namespace android
230