-
Notifications
You must be signed in to change notification settings - Fork 561
/
lkenv_v1.go
216 lines (197 loc) · 7.93 KB
/
lkenv_v1.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
// -*- Mode: Go; indent-tabs-mode: t -*-
/*
* Copyright (C) 2020 Canonical Ltd
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package lkenv
import (
"fmt"
)
// Following structure has to be kept in sync with c structure defined by
// include/lk/snappy-boot_v1.h
// c headerfile is used by bootloader, this ensures sync of the environment
// between snapd and bootloader
//
// when this structure needs to be updated,
// new version should be introduced instead together with c header file,
// which is to be adopted by bootloader
//
// !!! Support for old version has to be maintained, as it is not guaranteed
// all existing bootloader would adopt new version!
type SnapBootSelect_v1 struct {
/* Contains value BOOTSELECT_SIGNATURE defined above */
Signature uint32
/* snappy boot select version */
Version uint32
/* snap_mode, one of: 'empty', "try", "trying" */
Snap_mode [SNAP_FILE_NAME_MAX_LEN]byte
/* current core snap revision */
Snap_core [SNAP_FILE_NAME_MAX_LEN]byte
/* try core snap revision */
Snap_try_core [SNAP_FILE_NAME_MAX_LEN]byte
/* current kernel snap revision */
Snap_kernel [SNAP_FILE_NAME_MAX_LEN]byte
/* current kernel snap revision */
Snap_try_kernel [SNAP_FILE_NAME_MAX_LEN]byte
/* gadget_mode, one of: 'empty', "try", "trying" */
Gadget_mode [SNAP_FILE_NAME_MAX_LEN]byte
/* GADGET assets: current gadget assets revision */
Snap_gadget [SNAP_FILE_NAME_MAX_LEN]byte
/* GADGET assets: try gadget assets revision */
Snap_try_gadget [SNAP_FILE_NAME_MAX_LEN]byte
/**
* Reboot reason
* optional parameter to signal bootloader alternative reboot reasons
* e.g. recovery/factory-reset/boot asset update
*/
Reboot_reason [SNAP_FILE_NAME_MAX_LEN]byte
/**
* Matrix for mapping of boot img partition to installed kernel snap revision
*
* First column represents boot image partition label (e.g. boot_a,boot_b )
* value are static and should be populated at gadget built time
* or latest at image build time. Values are not further altered at run time.
* Second column represents name currently installed kernel snap
* e.g. pi2-kernel_123.snap
* initial value representing initial kernel snap revision
* is populated at image build time by snapd
*
* There are two rows in the matrix, representing current and previous kernel revision
* following describes how this matrix should be modified at different stages:
* - at image build time:
* - extracted kernel snap revision name should be filled
* into free slot (first row, second column)
* - snapd:
* - when new kernel snap revision is being installed, snapd cycles through
* matrix to find unused 'boot slot' to be used for new kernel snap revision
* from free slot, first column represents partition label to which kernel
* snap boot image should be extracted. Second column is then populated with
* kernel snap revision name.
* - snap_mode, snap_try_kernel, snap_try_core behaves same way as with u-boot
* - bootloader:
* - bootloader reads snap_mode to determine if snap_kernel or snap_try_kernel is used
* to get kernel snap revision name
* kernel snap revision is then used to search matrix to determine
* partition label to be used for current boot
* - bootloader NEVER alters this matrix values
*
* [ <bootimg 1 part label> ] [ <kernel snap revision installed in this boot partition> ]
* [ <bootimg 2 part label> ] [ <kernel snap revision installed in this boot partition> ]
*/
Bootimg_matrix [SNAP_BOOTIMG_PART_NUM][2][SNAP_FILE_NAME_MAX_LEN]byte
/**
* name of the boot image from kernel snap to be used for extraction
* when not defined or empty, default boot.img will be used
*/
Bootimg_file_name [SNAP_FILE_NAME_MAX_LEN]byte
/**
* gadget assets: Matrix for mapping of gadget asset partitions
* Optional boot asset tracking, based on bootloader support
* Some boot chains support A/B boot assets for increased robustness
* example being A/B TrustExecutionEnvironment
* This matrix can be used to track current and try boot assets for
* robust updates
* Use of Gadget_asset_matrix matches use of Bootimg_matrix
*
* [ <boot assets 1 part label> ] [ <currently installed assets revision in this partition> ]
* [ <boot assets 2 part label> ] [ <currently installed assets revision in this partition> ]
*/
Gadget_asset_matrix [SNAP_BOOTIMG_PART_NUM][2][SNAP_FILE_NAME_MAX_LEN]byte
/* unused placeholders for additional parameters in the future */
Unused_key_01 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_02 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_03 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_04 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_05 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_06 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_07 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_08 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_09 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_10 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_11 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_12 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_13 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_14 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_15 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_16 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_17 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_18 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_19 [SNAP_FILE_NAME_MAX_LEN]byte
Unused_key_20 [SNAP_FILE_NAME_MAX_LEN]byte
/* unused array of 10 key value pairs */
Key_value_pairs [10][2][SNAP_FILE_NAME_MAX_LEN]byte
/* crc32 value for structure */
Crc32 uint32
}
func newV1() *SnapBootSelect_v1 {
return &SnapBootSelect_v1{
Version: SNAP_BOOTSELECT_VERSION_V1,
Signature: SNAP_BOOTSELECT_SIGNATURE,
}
}
func (v1 *SnapBootSelect_v1) currentCrc32() uint32 { return v1.Crc32 }
func (v1 *SnapBootSelect_v1) currentVersion() uint32 { return v1.Version }
func (v1 *SnapBootSelect_v1) currentSignature() uint32 { return v1.Signature }
func (v1 *SnapBootSelect_v1) get(key string) string {
switch key {
case "snap_mode":
return cToGoString(v1.Snap_mode[:])
case "snap_kernel":
return cToGoString(v1.Snap_kernel[:])
case "snap_try_kernel":
return cToGoString(v1.Snap_try_kernel[:])
case "snap_core":
return cToGoString(v1.Snap_core[:])
case "snap_try_core":
return cToGoString(v1.Snap_try_core[:])
case "snap_gadget":
return cToGoString(v1.Snap_gadget[:])
case "snap_try_gadget":
return cToGoString(v1.Snap_try_gadget[:])
case "reboot_reason":
return cToGoString(v1.Reboot_reason[:])
case "bootimg_file_name":
return cToGoString(v1.Bootimg_file_name[:])
}
return ""
}
func (v1 *SnapBootSelect_v1) set(key, value string) {
switch key {
case "snap_mode":
copyString(v1.Snap_mode[:], value)
case "snap_kernel":
copyString(v1.Snap_kernel[:], value)
case "snap_try_kernel":
copyString(v1.Snap_try_kernel[:], value)
case "snap_core":
copyString(v1.Snap_core[:], value)
case "snap_try_core":
copyString(v1.Snap_try_core[:], value)
case "snap_gadget":
copyString(v1.Snap_gadget[:], value)
case "snap_try_gadget":
copyString(v1.Snap_try_gadget[:], value)
case "reboot_reason":
copyString(v1.Reboot_reason[:], value)
case "bootimg_file_name":
copyString(v1.Bootimg_file_name[:], value)
}
}
func (v1 *SnapBootSelect_v1) bootImgKernelMatrix() (bootimgMatrixGeneric, error) {
return (bootimgMatrixGeneric)((&v1.Bootimg_matrix)[:]), nil
}
func (v1 *SnapBootSelect_v1) bootImgRecoverySystemMatrix() (bootimgMatrixGeneric, error) {
return nil, fmt.Errorf("internal error: v1 lkenv has no boot image partition recovery system matrix")
}