blob: d85cb81868ec622d62d0251ebb6785a1f9375cf7 [file] [log] [blame]
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -08001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
Anatol Pomazau5ae3f932012-02-28 07:21:08 -080012 * the documentation and/or other materials provided with the
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080013 * distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
Anatol Pomazau5ae3f932012-02-28 07:21:08 -080022 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080023 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
Elliott Hughes6ebec932018-04-10 14:22:13 -070029#pragma once
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080030
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +000031#include <functional>
Dmitrii Merkurev0b627d92023-09-03 17:30:46 +010032#include <memory>
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +000033
David Pursell0b156632015-10-30 11:22:01 -070034#include "transport.h"
Elliott Hughes253c18d2015-03-18 22:47:09 -070035
Elliott Hughesfc797672015-04-07 20:12:50 -070036struct usb_ifc_info {
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080037 /* from device descriptor */
38 unsigned short dev_vendor;
39 unsigned short dev_product;
40
41 unsigned char dev_class;
42 unsigned char dev_subclass;
43 unsigned char dev_protocol;
Anatol Pomazau5ae3f932012-02-28 07:21:08 -080044
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080045 unsigned char ifc_class;
46 unsigned char ifc_subclass;
47 unsigned char ifc_protocol;
48
49 unsigned char has_bulk_in;
50 unsigned char has_bulk_out;
Anatol Pomazau5ae3f932012-02-28 07:21:08 -080051
Elliott Hughesb4add9b2009-10-06 18:07:49 -070052 unsigned char writable;
53
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080054 char serial_number[256];
Scott Anderson13081c62012-04-06 12:39:30 -070055 char device_path[256];
David Anderson4e058ca2020-05-28 04:39:37 +000056
57 char interface[256];
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080058};
Anatol Pomazau5ae3f932012-02-28 07:21:08 -080059
Aaron Wisneracf78d42018-07-26 10:56:09 -050060class UsbTransport : public Transport {
61 // Resets the underlying transport. Returns 0 on success.
62 // This effectively simulates unplugging and replugging
63 public:
64 virtual int Reset() = 0;
65};
66
Dmitrii Merkurev0ee285a2023-02-11 00:02:22 +000067typedef std::function<int(usb_ifc_info*)> ifc_match_func;
The Android Open Source Projectdd7bc332009-03-03 19:32:55 -080068
Aaron Wisneracf78d42018-07-26 10:56:09 -050069// 0 is non blocking
Dmitrii Merkurev0b627d92023-09-03 17:30:46 +010070std::unique_ptr<UsbTransport> usb_open(ifc_match_func callback, uint32_t timeout_ms = 0);