1 /*
2  * Copyright (C) 2015 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
12  *    the documentation and/or other materials provided with the
13  *    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
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * 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 
29 #pragma once
30 
31 #include <memory>
32 #include <string>
33 
34 #include "socket.h"
35 #include "transport.h"
36 
37 namespace udp {
38 
39 constexpr int kDefaultPort = 5554;
40 
41 // Returns a newly allocated Transport object connected to |hostname|:|port|. On failure, |error| is
42 // filled and nullptr is returned.
43 std::unique_ptr<Transport> Connect(const std::string& hostname, int port, std::string* error);
44 
45 // Internal namespace for test use only.
46 namespace internal {
47 
48 constexpr uint16_t kProtocolVersion = 1;
49 
50 // This will be negotiated with the device so may end up being smaller.
51 constexpr uint16_t kHostMaxPacketSize = 8192;
52 
53 // Retransmission constants. Retransmission timeout must be at least 500ms, and the host must
54 // attempt to send packets for at least 1 minute once the device has connected. See
55 // fastboot_protocol.txt for more information.
56 constexpr int kResponseTimeoutMs = 500;
57 constexpr int kMaxConnectAttempts = 4;
58 constexpr int kMaxTransmissionAttempts = 60 * 1000 / kResponseTimeoutMs;
59 
60 enum Id : uint8_t {
61     kIdError = 0x00,
62     kIdDeviceQuery = 0x01,
63     kIdInitialization = 0x02,
64     kIdFastboot = 0x03
65 };
66 
67 enum Flag : uint8_t {
68     kFlagNone = 0x00,
69     kFlagContinuation = 0x01
70 };
71 
72 // Creates a UDP Transport object using a given Socket. Used for unit tests to create a Transport
73 // object that uses a SocketMock.
74 std::unique_ptr<Transport> Connect(std::unique_ptr<Socket> sock, std::string* error);
75 
76 }  // namespace internal
77 
78 }  // namespace udp
79