libmsx/bmem__rd_8h_source.html

// -*- coding: utf-8-unix -*-

/*

 * Copyright (c) 2021-2024 Daishi Mori (mori0091)

 *

 * This software is released under the MIT License.\n

 * See https://github.com/mori0091/libmsx/blob/main/LICENSE

 *

 * GitHub libmsx project\n

 * https://github.com/mori0091/libmsx

 */

#ifndef BMEM_RD_H_

#define BMEM_RD_H_


#include "bmem.h"


#include <stdbool.h>

#include <stddef.h>

#include <stdint.h>


bool bmem_is_opened(void);


void bmem_open(bmemptr_t loc);


void bmem_close(void);


size_t bmem_avail(void);


void bmem_ensure(void);


const uint8_t * bmem_ptr(void);


void bmem_skip(size_t len);


void bmem_next_segment(void);


void bmem_read_chunk(uint8_t * dst, size_t len);


uint8_t bmem_read_byte(void);


#endif // BMEM_RD_H_

bmem.h
Data types and functions for accessing banked memory.

bmemptr_t
uint32_t bmemptr_t
Type of an address of banked memory.
Definition bmem.h:74

bmem_open
void bmem_open(bmemptr_t loc)
MSX Open Banked Memory accessor.

bmem_next_segment
void bmem_next_segment(void)
Switch to next segment.

bmem_ptr
const uint8_t * bmem_ptr(void)
Get the internal pointer value of Banked Memory accessor.

bmem_is_opened
bool bmem_is_opened(void)
MSX Tests whether Banked Memory accessor is opened or not.

bmem_skip
void bmem_skip(size_t len)
Advance the current position of Banked Memory accessor.

bmem_ensure
void bmem_ensure(void)
Ensure the internal pointer points the current position.

bmem_read_byte
uint8_t bmem_read_byte(void)
Read an octet from Banked Memory.

bmem_avail
size_t bmem_avail(void)
Return the size of remaining bytes in the current segment.

bmem_close
void bmem_close(void)
MSX Close Banked Memory accessor.

bmem_read_chunk
void bmem_read_chunk(uint8_t *dst, size_t len)
Read a chunk from Banked Memory.