• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2008 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_BOOTLOADER_H
18 #define _RECOVERY_BOOTLOADER_H
19 
20 #ifdef __cplusplus
21 extern "C" {
22 #endif
23 
24 /* Bootloader Message
25  *
26  * This structure describes the content of a block in flash
27  * that is used for recovery and the bootloader to talk to
28  * each other.
29  *
30  * The command field is updated by linux when it wants to
31  * reboot into recovery or to update radio or bootloader firmware.
32  * It is also updated by the bootloader when firmware update
33  * is complete (to boot into recovery for any final cleanup)
34  *
35  * The status field is written by the bootloader after the
36  * completion of an "update-radio" or "update-hboot" command.
37  *
38  * The recovery field is only written by linux and used
39  * for the system to send a message to recovery or the
40  * other way around.
41  *
42  * The stage field is written by packages which restart themselves
43  * multiple times, so that the UI can reflect which invocation of the
44  * package it is.  If the value is of the format "#/#" (eg, "1/3"),
45  * the UI will add a simple indicator of that status.
46  */
47 struct bootloader_message {
48     char command[32];
49     char status[32];
50     char recovery[768];
51 
52     // The 'recovery' field used to be 1024 bytes.  It has only ever
53     // been used to store the recovery command line, so 768 bytes
54     // should be plenty.  We carve off the last 256 bytes to store the
55     // stage string (for multistage packages) and possible future
56     // expansion.
57     char stage[32];
58     char reserved[224];
59 };
60 
61 /* Read and write the bootloader command from the "misc" partition.
62  * These return zero on success.
63  */
64 int get_bootloader_message(struct bootloader_message *out);
65 int set_bootloader_message(const struct bootloader_message *in);
66 
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif
72