diff options
author | Ian Moffett <ian@osmora.org> | 2025-10-12 21:13:24 -0400 |
---|---|---|
committer | Ian Moffett <ian@osmora.org> | 2025-10-12 21:13:43 -0400 |
commit | 1c45ac1ccf0569b6f99c4bc5eca7a262fd4aef08 (patch) | |
tree | 64b89dae5342690c251a88805d4dd3977b5c2c82 /emux64/src/include/rom.h | |
parent | b1c22317f2a3034952af3497fdb2394de7dc3a32 (diff) |
misc: Add initial fw ROM loading
Signed-off-by: Ian Moffett <ian@osmora.org>
Diffstat (limited to 'emux64/src/include/rom.h')
-rw-r--r-- | emux64/src/include/rom.h | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/emux64/src/include/rom.h b/emux64/src/include/rom.h new file mode 100644 index 0000000..8d3501c --- /dev/null +++ b/emux64/src/include/rom.h @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2025 Ian Marco Moffett and the Osmora Team. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of Hyra nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef ROM_H +#define ROM_H + +#include <stdint.h> +#include <stddef.h> + +/* + * Represents a firmware ROM file + * + * @buf: Buffer containing ROM data + * @length: Length of ROM + */ +struct osmx_rom { + uint8_t *buf; + size_t length; +}; + +/* + * Open a ROM file by path + * + * @path: Path to ROM file + * @res: Result of ROM descriptor + * + * Returns zero on success, otherwise a less than + * zero value on failure. + */ +int rom_open(const char *path, struct osmx_rom *res); + +/* + * Release resources associated with a ROM file + * + * @rom: ROM to release from host memory + */ +void rom_release(struct osmx_rom *rom); + +#endif /* ROM_H */ |