blob: de536fdb42aa809180e2167dd3cc7acda18c130a [file] [log] [blame]
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -08001/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef RECOVERY_COMMON_H
18#define RECOVERY_COMMON_H
19
Doug Zongker596b3422013-05-14 11:03:02 -070020#include <stdarg.h>
Tao Bao641fa972018-04-25 18:59:40 -070021#include <stdio.h>
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080022
Tao Baoed4a5372017-03-07 13:32:30 -080023#include <string>
24
Tao Baobd0ddcd2017-05-04 13:03:18 -070025// Not using the command-line defined macro here because this header could be included by
26// device-specific recovery libraries. We static assert the value consistency in recovery.cpp.
27static constexpr int kRecoveryApiVersion = 3;
Doug Zongkerfb2e3af2009-06-17 17:29:40 -070028
Tao Baoac9d94d2016-11-03 11:37:15 -070029class RecoveryUI;
30
31extern RecoveryUI* ui;
Tao Bao682c34b2015-04-07 17:16:35 -070032extern bool modified_flash;
Tao Baoac9d94d2016-11-03 11:37:15 -070033
34// The current stage, e.g. "1/2".
Tao Baoa8d72bc2016-12-25 18:46:50 -080035extern std::string stage;
Tao Baoac9d94d2016-11-03 11:37:15 -070036
37// The reason argument provided in "--reason=".
38extern const char* reason;
Doug Zongkercc8cd3f2010-09-20 12:16:13 -070039
Tao Bao6d99d4b2018-04-25 16:47:04 -070040// fopen(3)'s the given file, by mounting volumes and making parent dirs as necessary. Returns the
41// file pointer, or nullptr on error.
Tao Bao641fa972018-04-25 18:59:40 -070042FILE* fopen_path(const std::string& path, const char* mode);
Doug Zongker469243e2011-04-12 09:28:10 -070043
Tao Bao6d99d4b2018-04-25 16:47:04 -070044// In turn fflush(3)'s, fsync(3)'s and fclose(3)'s the given stream.
45void check_and_fclose(FILE* fp, const std::string& name);
46
Tao Baoaae7efd2018-04-26 10:24:03 -070047void ui_print(const char* format, ...) __printflike(1, 2);
Doug Zongker596b3422013-05-14 11:03:02 -070048
Elliott Hughesf14af802015-02-10 14:46:14 -080049bool is_ro_debuggable();
50
The Android Open Source Projectc24a8e62009-03-03 19:28:42 -080051#endif // RECOVERY_COMMON_H