1 /*
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
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 #ifndef _FASTBOOT_H_
30 #define _FASTBOOT_H_
31 
32 #include <inttypes.h>
33 #include <stdlib.h>
34 
35 #include <string>
36 
37 #include "transport.h"
38 
39 struct sparse_file;
40 
41 /* protocol.c - fastboot protocol */
42 int fb_command(Transport* transport, const std::string& cmd);
43 int fb_command_response(Transport* transport, const std::string& cmd, char* response);
44 int64_t fb_download_data(Transport* transport, const void* data, uint32_t size);
45 int64_t fb_download_data_fd(Transport* transport, int fd, uint32_t size);
46 int fb_download_data_sparse(Transport* transport, struct sparse_file* s);
47 int64_t fb_upload_data(Transport* transport, const char* outfile);
48 const std::string fb_get_error();
49 
50 #define FB_COMMAND_SZ 64
51 #define FB_RESPONSE_SZ 64
52 
53 /* engine.c - high level command queue engine */
54 bool fb_getvar(Transport* transport, const std::string& key, std::string* value);
55 void fb_queue_flash(const std::string& partition, void* data, uint32_t sz);
56 void fb_queue_flash_fd(const std::string& partition, int fd, uint32_t sz);
57 void fb_queue_flash_sparse(const std::string& partition, struct sparse_file* s, uint32_t sz,
58                            size_t current, size_t total);
59 void fb_queue_erase(const std::string& partition);
60 void fb_queue_format(const std::string& partition, int skip_if_not_supported, int32_t max_chunk_sz);
61 void fb_queue_require(const std::string& prod, const std::string& var, bool invert, size_t nvalues,
62                       const char** values);
63 void fb_queue_display(const std::string& label, const std::string& var);
64 void fb_queue_query_save(const std::string& var, char* dest, uint32_t dest_size);
65 void fb_queue_reboot(void);
66 void fb_queue_command(const std::string& cmd, const std::string& msg);
67 void fb_queue_download(const std::string& name, void* data, uint32_t size);
68 void fb_queue_download_fd(const std::string& name, int fd, uint32_t sz);
69 void fb_queue_upload(const std::string& outfile);
70 void fb_queue_notice(const std::string& notice);
71 void fb_queue_wait_for_disconnect(void);
72 int64_t fb_execute_queue(Transport* transport);
73 void fb_set_active(const std::string& slot);
74 
75 /* util stuff */
76 double now();
77 char* xstrdup(const char*);
78 
79 // These printf-like functions are implemented in terms of vsnprintf, so they
80 // use the same attribute for compile-time format string checking. On Windows,
81 // if the mingw version of vsnprintf is used, use `gnu_printf' which allows z
82 // in %zd and PRIu64 (and related) to be recognized by the compile-time
83 // checking.
84 #define FASTBOOT_FORMAT_ARCHETYPE __printf__
85 #ifdef __USE_MINGW_ANSI_STDIO
86 #if __USE_MINGW_ANSI_STDIO
87 #undef FASTBOOT_FORMAT_ARCHETYPE
88 #define FASTBOOT_FORMAT_ARCHETYPE gnu_printf
89 #endif
90 #endif
91 void die(const char* fmt, ...) __attribute__((__noreturn__))
92 __attribute__((__format__(FASTBOOT_FORMAT_ARCHETYPE, 1, 2)));
93 #undef FASTBOOT_FORMAT_ARCHETYPE
94 
95 /* Current product */
96 extern char cur_product[FB_RESPONSE_SZ + 1];
97 
98 #endif
99