Skip to content

Fix bugs in esp32 mkimage.erl script #2093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
UncleGrumpy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix bugs in esp32 mkimage.erl script #2093

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 77 additions & 51 deletions src/platforms/esp32/tools/mkimage.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,60 +135,86 @@ mkimage(RootDir, BootFile, OutputFile, Segments) ->
io:format("=============================================~n"),
case file:open(OutputFile, [write, binary]) of
{ok, Fout} ->
lists:foldl(
fun(Segment, PrevOffset) ->
SegmentOffset = from_hex(maps:get(offset, Segment)),
case PrevOffset of
undefined ->
no_padding;
_ ->
case SegmentOffset > PrevOffset of
true ->
Padding = [
16#FF
|| _ <- lists:seq(1, SegmentOffset - PrevOffset)
],
io:format("Padding ~p bytes~n", [SegmentOffset - PrevOffset]),
file:write(Fout, Padding);
false ->
throw(
io_lib:format(
"Error: insufficient space for segment ~p. Over by: ~p bytes~n",
[
maps:get(name, Segment), PrevOffset - SegmentOffset
]
)
)
end
end,
SegmentPaths = [
replace(
"BOOT_FILE", BootFile, replace("ROOT_DIR", RootDir, SegmentPath)
try
write_segments(RootDir, BootFile, Fout, Segments)
after
file:close(Fout)
end;
{error, Reason} ->
throw(io_lib:format("Failed to open ~s for writing. Reason: ~p", [OutputFile, Reason]))
end.

%% @private
write_segments(_RootDir, _BootFile, Fout, []) ->
ok;
write_segments(RootDir, BootFile, Fout, [Segment | Segments]) ->
SegmentOffset = from_hex(maps:get(offset, Segment)),
SegmentPaths = [
replace(
"BOOT_FILE", BootFile, replace("ROOT_DIR", RootDir, SegmentPath)
)
|| SegmentPath <- maps:get(path, Segment)
],
SegmentEnd =
case try_read(SegmentPaths) of
{ok, Data} ->
case file:write(Fout, Data) of
ok ->
ok;
{error, WriteError} ->
Fmt = "Failed to write segment data from ~p to image. Reason: ~p.",
throw(io_lib:format(Fmt, [SegmentPaths, WriteError]))
end,
io:format("Wrote ~s (~p bytes) at offset ~s (~p)~n", [
maps:get(name, Segment),
byte_size(Data),
maps:get(offset, Segment),
SegmentOffset
]),
SegmentOffset + byte_size(Data);
{error, Reason} ->
Fmt =
"Failed to read file ~p Reason: ~p."
" Note that a full build is required before running this command.",
throw(io_lib:format(Fmt, [SegmentPaths, Reason]))
end,
if
Segments == [] ->
%% Pad to end on 32-byte alignment, since we don't have a next offset to pad to.
SectorPad = (32 - (SegmentEnd rem 32)) rem 32,
pad_to_size(Fout, SectorPad);
true ->
[PeekNext | _] = Segments,
NextOffset = from_hex(maps:get(offset, PeekNext)),
case SegmentEnd > NextOffset of
true ->
throw(
io_lib:format(
"Error: insufficient space for segment ~p. Overflows partition by: ~p bytes~n",
[maps:get(name, Segment), SegmentEnd - NextOffset]
)
|| SegmentPath <- maps:get(path, Segment)
],
case try_read(SegmentPaths) of
{ok, Data} ->
file:write(Fout, Data),
io:format("Wrote ~s (~p bytes) at offset ~s (~p)~n", [
maps:get(name, Segment),
byte_size(Data),
maps:get(offset, Segment),
SegmentOffset
]),
SegmentOffset + byte_size(Data);
{error, Reason} ->
Fmt =
"Failed to read file ~p Reason: ~p."
" Note that a full build is required before running this command.",
throw(io_lib:format(Fmt, [SegmentPaths, Reason]))
);
false ->
PadSize = NextOffset - SegmentEnd,
case PadSize of
0 ->
ok;
PadSize ->
ok = pad_to_size(Fout, PadSize)
end
end,
undefined,
Segments
);
end
end,
write_segments(RootDir, BootFile, Fout, Segments).

%% @private
pad_to_size(Fout, PadSize) ->
Padding = [16#FF || _ <- lists:seq(1, PadSize)],
case file:write(Fout, Padding) of
ok ->
io:format("Padded ~p bytes~n", [PadSize]);
{error, Reason} ->
throw(io_lib:format("Failed to open ~s for writing. Reason: ~p", [OutputFile, Reason]))
Fmt = "Failed to add ~p bytes padding. Reason: ~p.",
throw(io_lib:format(Fmt, [PadSize, Reason]))
end.

%% @private
Expand Down
Loading