virtual_mem.h File Reference

#include "conf_access.h"
#include "ctrl_access.h"

Macros
#define	ENTRY_SIZE   32
	FAT specification. More...
#define	FAT_SECTOR   (PBR_SECTOR + VMEM_RESERVED_SIZE)
#define	FILE_SECTOR   (ROOT_SECTOR + VMEM_NB_ROOT_ENTRY * ENTRY_SIZE / VMEM_SECTOR_SIZE)
#define	FILE_SIZE   16
#define	PBR_SECTOR   0
#define	ROOT_SECTOR   (FAT_SECTOR + VMEM_NB_FATS * VMEM_SIZE_FAT)
#define	VMEM_CLUSTER_SIZE   1
#define	VMEM_MEDIA_TYPE   0xF8
#define	VMEM_NB_FATS   2
#define	VMEM_NB_HEAD   1
#define	VMEM_NB_HIDDEN_SECT   0
#define	VMEM_NB_ROOT_ENTRY   16
#define	VMEM_NB_SECTOR   (FILE_SIZE * VMEM_CLUSTER_SIZE + FILE_SECTOR)
#define	VMEM_RESERVED_SIZE   1
#define	VMEM_SECT_PER_TRACK   1
#define	VMEM_SECTOR_SIZE   512
	Value of virtual PBR. More...
#define	VMEM_SIZE_FAT   1
#define	VMEN_DRIVE_NUMBER   0x80

Functions
Ctrl_status	virtual_mem_2_ram (uint32_t addr, void *ram)
	This function transfers 1 data sector from memory to RAM sector = 512 bytes. More...
Ctrl_status	virtual_ram_2_mem (uint32_t addr, const void *ram)
	This function transfers 1 data sector from memory to RAM sector = 512 bytes. More...
Ctrl_status	virtual_read_capacity (uint32_t *u32_nb_sector)
	This function returns the address of the last valid sector. More...
bool	virtual_removal (void)
	This function informs about the memory type. More...
Ctrl_status	virtual_test_unit_ready (void)
	This function tests memory state, and starts memory initialization. More...
Ctrl_status	virtual_usb_read_10 (uint32_t addr, uint16_t nb_sector)
	This function transfers the memory data (programmed in sbc_read_10) directly to the USB interface sector = 512 bytes. More...
Ctrl_status	virtual_usb_write_10 (uint32_t addr, uint16_t nb_sector)
	This function transfers the USB data (programmed in sbc_write_10) directly to the memory interface sector = 512 bytes. More...
bool	virtual_wr_protect (void)
	This function returns the write-protected mode Only used by memory removal with a HARDWARE-SPECIFIC write-protected detection. More...

#define ENTRY_SIZE   32

FAT specification.

#define FAT_SECTOR   (PBR_SECTOR + VMEM_RESERVED_SIZE)

Referenced by virtual_check_init().

#define FILE_SECTOR   (ROOT_SECTOR + VMEM_NB_ROOT_ENTRY * ENTRY_SIZE / VMEM_SECTOR_SIZE)

#define FILE_SIZE   16

#define PBR_SECTOR   0

Referenced by virtual_check_init().

#define ROOT_SECTOR   (FAT_SECTOR + VMEM_NB_FATS * VMEM_SIZE_FAT)

#define VMEM_CLUSTER_SIZE   1

Referenced by virtual_check_init().

#define VMEM_MEDIA_TYPE   0xF8

Referenced by virtual_check_init().

#define VMEM_NB_FATS   2

Referenced by virtual_check_init().

#define VMEM_NB_HEAD   1

Referenced by virtual_check_init().

#define VMEM_NB_HIDDEN_SECT   0

Referenced by virtual_check_init().

#define VMEM_NB_ROOT_ENTRY   16

Referenced by virtual_check_init().

#define VMEM_NB_SECTOR   (FILE_SIZE * VMEM_CLUSTER_SIZE + FILE_SECTOR)

Referenced by virtual_check_init(), virtual_mem_2_ram(), virtual_ram_2_mem(), virtual_read_capacity(), virtual_usb_read_10(), and virtual_usb_write_10().

#define VMEM_RESERVED_SIZE   1

Referenced by virtual_check_init().

#define VMEM_SECT_PER_TRACK   1

Referenced by virtual_check_init().

#define VMEM_SECTOR_SIZE   512

Value of virtual PBR.

Referenced by virtual_check_init(), virtual_mem_2_ram(), virtual_ram_2_mem(), virtual_usb_read_10(), and virtual_usb_write_10().

#define VMEM_SIZE_FAT   1

Referenced by virtual_check_init().

#define VMEN_DRIVE_NUMBER   0x80

Referenced by virtual_check_init().

Ctrl_status virtual_mem_2_ram	(	uint32_t	addr,
		void *	ram
	)

This function transfers 1 data sector from memory to RAM sector = 512 bytes.

Parameters

addr	Sector address to start read
ram	Address of RAM buffer

Returns

Ctrl_status It is ready -> CTRL_GOOD Memory unplug -> CTRL_NO_PRESENT Not initialized or changed -> CTRL_BUSY An error occurred -> CTRL_FAIL

References CTRL_FAIL, CTRL_GOOD, Max, min, virtual_check_init(), vmem_data, VMEM_NB_SECTOR, and VMEM_SECTOR_SIZE.

Ctrl_status virtual_ram_2_mem	(	uint32_t	addr,
		const void *	ram
	)

This function transfers 1 data sector from memory to RAM sector = 512 bytes.

Parameters

addr	Sector address to start write
ram	Address of RAM buffer

Returns

Ctrl_status It is ready -> CTRL_GOOD Memory unplug -> CTRL_NO_PRESENT Not initialized or changed -> CTRL_BUSY An error occurred -> CTRL_FAIL

References CTRL_FAIL, CTRL_GOOD, virtual_check_init(), vmem_data, VMEM_NB_SECTOR, and VMEM_SECTOR_SIZE.

Ctrl_status virtual_read_capacity

(

uint32_t *

u32_nb_sector

)

This function returns the address of the last valid sector.

Parameters

u32_nb_sector

Pointer to number of sectors (sector = 512 bytes)

Returns

Ctrl_status It is ready -> CTRL_GOOD Memory unplug -> CTRL_NO_PRESENT Not initialized or changed -> CTRL_BUSY An error occurred -> CTRL_FAIL

References CTRL_GOOD, Max, virtual_check_init(), and VMEM_NB_SECTOR.

bool virtual_removal

(

void

)

This function informs about the memory type.

Returns

true if the memory is removable

Ctrl_status virtual_test_unit_ready

(

void

)

This function tests memory state, and starts memory initialization.

Returns

Ctrl_status It is ready -> CTRL_GOOD Memory unplug -> CTRL_NO_PRESENT Not initialized or changed -> CTRL_BUSY An error occurred -> CTRL_FAIL

References CTRL_GOOD, and virtual_check_init().

Ctrl_status virtual_usb_read_10	(	uint32_t	addr,
		uint16_t	nb_sector
	)

This function transfers the memory data (programmed in sbc_read_10) directly to the USB interface sector = 512 bytes.

Parameters

addr	Sector address to start read
nb_sector	Number of sectors to transfer

Returns

Ctrl_status It is ready -> CTRL_GOOD Memory unplug -> CTRL_NO_PRESENT Not initialized or changed -> CTRL_BUSY An error occurred -> CTRL_FAIL

References CTRL_FAIL, CTRL_GOOD, data_to_transfer, g_scsi_ep_ms_in, Is_usb_endpoint_enabled, Is_usb_in_ready, Max, min, Usb_ack_in_ready_send, Usb_reset_endpoint_fifo_access, usb_write_ep_txpacket(), virtual_check_init(), vmem_data, VMEM_NB_SECTOR, and VMEM_SECTOR_SIZE.

Ctrl_status virtual_usb_write_10	(	uint32_t	addr,
		uint16_t	nb_sector
	)

This function transfers the USB data (programmed in sbc_write_10) directly to the memory interface sector = 512 bytes.

Parameters

addr	Sector address to start write
nb_sector	Number of sectors to transfer

Returns

Ctrl_status It is ready -> CTRL_GOOD Memory unplug -> CTRL_NO_PRESENT Not initialized or changed -> CTRL_BUSY An error occurred -> CTRL_FAIL

References CTRL_FAIL, CTRL_GOOD, data_to_transfer, g_scsi_ep_ms_out, Is_usb_endpoint_enabled, Is_usb_out_received, Usb_ack_out_received_free, usb_read_ep_rxpacket(), Usb_reset_endpoint_fifo_access, virtual_check_init(), vmem_data, VMEM_NB_SECTOR, and VMEM_SECTOR_SIZE.

bool virtual_wr_protect

(

void

)

This function returns the write-protected mode Only used by memory removal with a HARDWARE-SPECIFIC write-protected detection.

Warning

The customer must unplug the memory to change this write-protected mode.

Returns

true if the memory is protected