operation.h

#ifndef _OPERATION_H_
#define _OPERATION_H_

#include <stdint.h>
#include <unistd.h>
#include <stdbool.h>

// --- DEFINE ---

#define STATE_MACHINE_NUM 3

typedef enum {

    OP_WRITE_EQUAL,       // Perform a write operation and check if the written value matches the expected value
    OP_WRITE_STORE,       // Store the written value into a specific location (used in callbacks)
    OP_WRITE_STORE_LOOP,  // Store the written value into a specific location multiple time
    OP_READ_INJECT,       // Inject a value into the guest from a specific address
    OP_EMUL_END,          // End of the state machine, with an callback for completion
} operation_t;

typedef struct {

    operation_t op;                 // the operation to perform
    uint64_t addr;                  // the address written to/read from
    uint32_t value;                 // the expected written value or value to inject
    uint8_t size;                   // the size of the operation (8, 16 or 32 bits)
    void (*callback)(void *addr);   // custom function that would be executed at the end of the state
} state_t;

extern bool flag_stop_loop;
extern char *disk_path;
extern state_t *STATE_ALL_STARTERS[];

// --- FUNCITON ---

/**
 * @brief Callback function triggered when the console operation concludes.
 *
 * @param addr Address containing the console message to be printed.
 */
void op_callback_console_conclude(void *addr);

/**
 * @brief Callback function to store the timer value during the state machine execution.
 *
 * @param addr Address of the timer value to be stored.
 */
void op_callback_timer_store(void *addr);

/**
 * @brief Callback function to conclude the timer operation and set the sleep timer.
 *
 * @param addr Address of the timer parameters, or `NULL` to use previously stored values.
 */
void op_callback_timer_conclude(void *addr);

/**
 * @brief Callback function to store the width during graphics initialization.
 *
 * @param addr Address of the width value to be stored.
 */
void op_callback_gfx_init_store_w(void *addr);

/**
 * @brief Callback function to store the height during graphics initialization.
 *
 * @param addr Address of the height value to be stored.
 */
void op_callback_gfx_init_store_h(void *addr);

/**
 * @brief Callback function to conclude the graphics initialization process.
 *
 * @param addr Address of the graphics parameters, or `NULL` to use previously stored values.
 */
void op_callback_gfx_init_conclude(void *addr);

/**
 * @brief Prepares for an IDE operation by setting up necessary parameters.
 *
 * @param addr Address of the IDE parameters or `NULL` if using previously configured parameters.
 */
void op_callback_ide_prepare(void *addr);

/**
 * @brief Stores data in the first sector for an IDE operation.
 *
 * @param addr Address containing the data to be stored in sector 1, or `NULL` to use pre-existing data.
 */
void op_callback_ide_store_sector_1(void *addr);

/**
 * @brief Stores data in the second sector for an IDE operation.
 *
 * @param addr Address containing the data to be stored in sector 2, or `NULL` to use pre-existing data.
 */
void op_callback_ide_store_sector_2(void *addr);

/**
 * @brief Stores data in the third sector for an IDE operation.
 *
 * @param addr Address containing the data to be stored in sector 3, or `NULL` to use pre-existing data.
 */
void op_callback_ide_store_sector_3(void *addr);

/**
 * @brief Stores data in the fourth sector for an IDE operation.
 *
 * @param addr Address containing the data to be stored in sector 4, or `NULL` to use pre-existing data.
 */
void op_callback_ide_store_sector_4(void *addr);

/**
 * @brief Stores the entire data payload for an IDE operation.
 *
 * @param addr Address containing the complete IDE data payload, or `NULL` if previously stored data is to be used.
 */
void op_callback_ide_store_data(void *addr);

/**
 * @brief Concludes the IDE operation by finalizing data transfer or processing steps.
 *
 * @param addr Address of the concluding parameters for the IDE operation, or `NULL` to use previously set parameters.
 */
void op_callback_ide_conclude(void *addr);

void op_callback_sprite_init_prepare(void *addr);

void op_callback_sprite_init_store_id(void *addr);

void op_callback_sprite_init_store_width(void *addr);

void op_callback_sprite_init_store_height(void *addr);

void op_callback_sprite_init_store_pixels(void *addr);

void op_callback_sprite_init_conclude(void *addr);

void op_callback_sprite_visibility_store_id(void *addr);

void op_callback_sprite_visibility_store_toggle(void *addr);

void op_callback_sprite_visibility_conclude(void *addr);

void op_callback_sprite_position_store_id(void *addr);

void op_callback_sprite_position_store_x(void *addr);

void op_callback_sprite_position_store_y(void *addr);

void op_callback_sprite_position_conclude(void *addr);

#endif // _OPERATION_H_