N64FlashcartMenu/src/flashcart/flashcart.h
Mateusz Faderewski 1eb654d1c1
64DD disk loading support for SummerCart64 (#49) (and other fixes/improvements)
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- What does this sample do? What problem does it solve? -->
<!--- If it fixes/closes/resolves an open issue, please link to the
issue here -->

## How Has This Been Tested?
<!-- (if applicable) -->
<!--- Please describe in detail how you tested your sample/changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots
<!-- (if appropriate): -->

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Improvement (non-breaking change that adds a new feature)
- [ ] Bug fix (fixes an issue)
- [ ] Breaking change (breaking change)
- [ ] Config and build (change in the configuration and build system,
has no impact on code or features)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

<!--- It would be nice if you could sign off your contribution by
replacing the name with your GitHub user name and GitHub email contact.
-->
Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL>

---------

Signed-off-by: Polprzewodnikowy <sc@mateuszfaderewski.pl>
Co-authored-by: Robin Jones <networkfusion@users.noreply.github.com>
2023-10-10 21:12:53 +02:00

81 lines
2.6 KiB
C

/**
* @file flashcart.h
* @brief Flashcart Subsystem
* @ingroup flashcart
*/
#ifndef FLASHCART_H__
#define FLASHCART_H__
#include <stdbool.h>
#include <stdint.h>
/** @brief Flashcart error enumeration */
typedef enum {
FLASHCART_OK,
FLASHCART_ERR_NOT_DETECTED,
FLASHCART_ERR_OUTDATED,
FLASHCART_ERR_SD_CARD,
FLASHCART_ERR_ARGS,
FLASHCART_ERR_LOAD,
FLASHCART_ERR_INT,
FLASHCART_ERR_FUNCTION_NOT_SUPPORTED,
} flashcart_err_t;
/** @brief List of optional supported flashcart features */
typedef enum {
FLASHCART_FEATURE_64DD,
} flashcart_features_t;
/** @brief Flashcart save type enumeration */
typedef enum {
FLASHCART_SAVE_TYPE_NONE,
FLASHCART_SAVE_TYPE_EEPROM_4K,
FLASHCART_SAVE_TYPE_EEPROM_16K,
FLASHCART_SAVE_TYPE_SRAM,
FLASHCART_SAVE_TYPE_SRAM_BANKED,
FLASHCART_SAVE_TYPE_SRAM_128K,
FLASHCART_SAVE_TYPE_FLASHRAM,
FLASHCART_SAVE_TYPE_FLASHRAM_PKST2,
__FLASHCART_SAVE_TYPE_END
} flashcart_save_type_t;
typedef struct {
bool development_drive;
uint8_t disk_type;
bool bad_system_area_lbas[24];
uint8_t defect_tracks[16][12];
} flashcart_disk_parameters_t;
typedef void flashcart_progress_callback_t (float progress);
/** @brief Flashcart Structure */
typedef struct {
flashcart_err_t (*init) (void);
flashcart_err_t (*deinit) (void);
bool (*has_feature) (flashcart_features_t feature);
flashcart_err_t (*load_rom) (char *rom_path, flashcart_progress_callback_t *progress);
flashcart_err_t (*load_file) (char *file_path, uint32_t rom_offset, uint32_t file_offset);
flashcart_err_t (*load_save) (char *save_path);
flashcart_err_t (*load_64dd_ipl) (char *ipl_path, flashcart_progress_callback_t *progress);
flashcart_err_t (*load_64dd_disk) (char *disk_path, flashcart_disk_parameters_t *disk_parameters);
flashcart_err_t (*set_save_type) (flashcart_save_type_t save_type);
flashcart_err_t (*set_save_writeback) (uint32_t *sectors);
} flashcart_t;
char *flashcart_convert_error_message (flashcart_err_t err);
flashcart_err_t flashcart_init (void);
flashcart_err_t flashcart_deinit (void);
bool flashcart_has_feature (flashcart_features_t feature);
flashcart_err_t flashcart_load_rom (char *rom_path, bool byte_swap, flashcart_progress_callback_t *progress);
flashcart_err_t flashcart_load_file (char *file_path, uint32_t rom_offset, uint32_t file_offset);
flashcart_err_t flashcart_load_save (char *save_path, flashcart_save_type_t save_type);
flashcart_err_t flashcart_load_64dd_ipl (char *ipl_path, flashcart_progress_callback_t *progress);
flashcart_err_t flashcart_load_64dd_disk (char *disk_path, flashcart_disk_parameters_t *disk_parameters);
#endif