Detailed Description

Interface for FileX Block Media port.

Summary

The FileX block media port provides notifications for insertion and removal of removable media and provides initialization functions required by FileX.

Data Structures
struct	rm_filex_block_media_callback_args_t

struct	rm_filex_block_media_cfg_t

struct	rm_filex_block_media_api_t

struct	rm_filex_block_media_instance_t

Typedefs
typedef void	rm_filex_block_media_ctrl_t

Enumerations
enum	rm_filex_block_media_partition_t

Data Structure Documentation

◆ rm_filex_block_media_callback_args_t

struct rm_filex_block_media_callback_args_t

Callback function parameter data

Data Fields
rm_block_media_event_t	event	The event can be used to identify what caused the callback.
void const *	p_context	Placeholder for user data.

◆ rm_filex_block_media_cfg_t

struct rm_filex_block_media_cfg_t

Block media configuration structure

Data Fields
rm_block_media_instance_t *	p_lower_lvl_block_media
	Lower level block media pointer.

rm_filex_block_media_partition_t	partition
	Partition to use for partitioned media.

void(*	p_callback )(rm_filex_block_media_callback_args_t *p_args)
	Pointer to callback function.

◆ rm_filex_block_media_api_t

struct rm_filex_block_media_api_t

FileX block media functions implemented at the HAL layer will follow this API.

Data Fields
fsp_err_t(*	open )(rm_filex_block_media_ctrl_t const p_ctrl, rm_filex_block_media_cfg_t const const p_cfg)

fsp_err_t(*	close )(rm_filex_block_media_ctrl_t *const p_ctrl)

Field Documentation

◆ open

fsp_err_t(* rm_filex_block_media_api_t::open) (rm_filex_block_media_ctrl_t *const p_ctrl, rm_filex_block_media_cfg_t const *const p_cfg)

Open media device.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_cfg	Pointer to configuration structure.

◆ close

fsp_err_t(* rm_filex_block_media_api_t::close) (rm_filex_block_media_ctrl_t *const p_ctrl)

Close media device.

Parameters

[in] p_ctrl Pointer to control structure.

◆ rm_filex_block_media_instance_t

struct rm_filex_block_media_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
rm_filex_block_media_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
rm_filex_block_media_cfg_t const *const	p_cfg	Pointer to the configuration structure for this instance.
rm_filex_block_media_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

◆ rm_filex_block_media_ctrl_t

typedef void rm_filex_block_media_ctrl_t

Block media control structure

Enumeration Type Documentation

◆ rm_filex_block_media_partition_t

enum rm_filex_block_media_partition_t

Partitions that can be selected to use FileX with

Enumerator
RM_FILEX_BLOCK_MEDIA_PARTITION0	Partition 0 (0x01BE) in Master Boot Record Partition Table.
RM_FILEX_BLOCK_MEDIA_PARTITION1	Partition 1 (0x01CE) in Master Boot Record Partition Table.
RM_FILEX_BLOCK_MEDIA_PARTITION2	Partition 2 (0x01DE) in Master Boot Record Partition Table.
RM_FILEX_BLOCK_MEDIA_PARTITION3	Partition 3 (0x01EE) in Master Boot Record Partition Table.