flash_common.c File Reference

#include "hal/driver/driver.h"

Macros
#define	VSF_FLASH_CFG_FUNCTION_RENAME   DISABLED

Functions
vsf_err_t	vsf_flash_init (vsf_flash_t *flash_ptr, vsf_flash_cfg_t *cfg_ptr)
	initialize a flash instance.
void	vsf_flash_fini (vsf_flash_t *flash_ptr)
	finalize a flash instance.
fsm_rt_t	vsf_flash_enable (vsf_flash_t *flash_ptr)
	enable interrupt masks of flash instance.
fsm_rt_t	vsf_flash_disable (vsf_flash_t *flash_ptr)
	disable interrupt masks of flash instance.
void	vsf_flash_irq_enable (vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t irq_mask)
	enable interrupt masks of flash instance.
void	vsf_flash_irq_disable (vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t irq_mask)
	disable interrupt masks of flash instance.
vsf_flash_status_t	vsf_flash_status (vsf_flash_t *flash_ptr)
	get the status of flash instance.
vsf_flash_capability_t	vsf_flash_capability (vsf_flash_t *flash_ptr)
	get the capability of flash instance.
vsf_err_t	vsf_flash_erase_one_sector (vsf_flash_t *flash_ptr, uint_fast32_t offset)
	flash erase one sector.
vsf_err_t	vsf_flash_erase_multi_sector (vsf_flash_t *flash_ptr, uint_fast32_t offset, uint_fast32_t size)
	flash erase a continuous range
vsf_err_t	vsf_flash_erase_all (vsf_flash_t *flash_ptr)
	flash chip erase
vsf_err_t	vsf_flash_write_one_sector (vsf_flash_t *flash_ptr, uint_fast32_t offset, uint8_t *buffer, uint_fast32_t size)
	flash write one sector
vsf_err_t	vsf_flash_write_multi_sector (vsf_flash_t *flash_ptr, uint_fast32_t offset, uint8_t *buffer, uint_fast32_t size)
	flash write multi sector
vsf_err_t	vsf_flash_read_one_sector (vsf_flash_t *flash_ptr, uint_fast32_t offset, uint8_t *buffer, uint_fast32_t size)
	flash read one sector
vsf_err_t	vsf_flash_read_multi_sector (vsf_flash_t *flash_ptr, uint_fast32_t offset, uint8_t *buffer, uint_fast32_t size)
	flash read multi sector

Macro Definition Documentation

VSF_FLASH_CFG_FUNCTION_RENAME

#define VSF_FLASH_CFG_FUNCTION_RENAME   DISABLED

Function Documentation

vsf_flash_init()

vsf_err_t vsf_flash_init	(	vsf_flash_t *	flash_ptr,
		vsf_flash_cfg_t *	cfg_ptr
	)

initialize a flash instance.

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	cfg_ptr	a pointer to structure vsf_flash_cfg_t

Returns

vsf_err_t: VSF_ERR_NONE if flash was initialized, or a negative error code

Note

It is not necessary to call vsf_flash_fini() to deinitialization. vsf_flash_init() should be called before any other flash API except vsf_flash_capability().

vsf_flash_fini()

void vsf_flash_fini

(

vsf_flash_t *

flash_ptr

)

finalize a flash instance.

Parameters

[in]

flash_ptr

a pointer to structure vsf_flash_t

Returns

none

vsf_flash_enable()

fsm_rt_t vsf_flash_enable

(

vsf_flash_t *

flash_ptr

)

enable interrupt masks of flash instance.

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	irq_mask	one or more value of enum vsf_flash_irq_mask_t

Returns

none.

vsf_flash_disable()

fsm_rt_t vsf_flash_disable

(

vsf_flash_t *

flash_ptr

)

disable interrupt masks of flash instance.

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	irq_mask	one or more value of enum vsf_flash_irq_mask_t, vsf_flash_irq_mask_t

Returns

none.

vsf_flash_irq_enable()

void vsf_flash_irq_enable	(	vsf_flash_t *	flash_ptr,
		vsf_flash_irq_mask_t	irq_mask
	)

enable interrupt masks of flash instance.

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	irq_mask	one or more value of enum vsf_flash_irq_mask_t

Returns

none.

Note

All pending interrupts should be cleared before interrupts are enabled.

vsf_flash_irq_disable()

void vsf_flash_irq_disable	(	vsf_flash_t *	flash_ptr,
		vsf_flash_irq_mask_t	irq_mask
	)

disable interrupt masks of flash instance.

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	irq_mask	one or more value of enum vsf_flash_irq_mask_t, vsf_flash_irq_mask_t

Returns

none.

vsf_flash_status()

vsf_flash_status_t vsf_flash_status

(

vsf_flash_t *

flash_ptr

)

get the status of flash instance.

Parameters

[in]

flash_ptr

a pointer to structure vsf_flash_t

Returns

vsf_flash_status_t: return all status of current flash vsf_flash_status_t

vsf_flash_capability()

vsf_flash_capability_t vsf_flash_capability

(

vsf_flash_t *

flash_ptr

)

get the capability of flash instance.

Parameters

[in]

flash_ptr

a pointer to structure vsf_flash_t

Returns

vsf_flash_capability_t: return all capability of current flash vsf_flash_capability_t

vsf_flash_erase_one_sector()

vsf_err_t vsf_flash_erase_one_sector	(	vsf_flash_t *	flash_ptr,
		vsf_flash_size_t	offset_of_bytes
	)

flash erase one sector.

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	offset_of_bytes	The address of the sector to be erased, needs to be an integer multiple of the smallest erasable sector size

Returns

vsf_err_t: VSF_ERR_NONE if flash starts to perform the erase, or a negative error code

vsf_flash_erase_multi_sector()

vsf_err_t vsf_flash_erase_multi_sector	(	vsf_flash_t *	flash_ptr,
		vsf_flash_size_t	offset_of_bytes,
		vsf_flash_size_t	size_of_bytes
	)

flash erase a continuous range

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	offset_of_bytes	The address of the sector to be erased, needs to be an integer multiple of the smallest erasable sector size
[in]	size_of_bytes	a pointer to structure vsf_flash_t

Returns

vsf_err_t: VSF_ERR_NONE if flash starts to perform the erase, or a negative error code

vsf_flash_erase_all()

vsf_err_t vsf_flash_erase_all

(

vsf_flash_t *

flash_ptr

)

flash chip erase

Parameters

[in]

flash_ptr

a pointer to structure vsf_flash_t

Returns

vsf_err_t: VSF_ERR_NONE if flash starts to perform the chip erase, or a negative error code

vsf_flash_write_one_sector()

vsf_err_t vsf_flash_write_one_sector	(	vsf_flash_t *	flash_ptr,
		vsf_flash_size_t	offset_of_bytes,
		uint8_t *	buffer,
		vsf_flash_size_t	size_of_bytes
	)

flash write one sector

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	offset_of_bytes	Address of the sector to be written, some flash requires an integer multiple of the smallest writable sector size
[in]	buffer	a pointer to data
[in]	size_of_bytes	a pointer to data

Returns

vsf_err_t: VSF_ERR_NONE if flash starts to perform the chip erase, or a negative error code

vsf_flash_write_multi_sector()

vsf_err_t vsf_flash_write_multi_sector	(	vsf_flash_t *	flash_ptr,
		vsf_flash_size_t	offset_of_bytes,
		uint8_t *	buffer,
		vsf_flash_size_t	size_of_bytes
	)

flash write multi sector

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	offset_of_bytes	Address of the sector to be written, some flash requires an integer multiple of the smallest writable sector size
[in]	buffer	a pointer to data
[in]	size_of_bytes	a pointer to data

Returns

vsf_err_t: VSF_ERR_NONE if flash starts to perform the chip erase, or a negative error code

vsf_flash_read_one_sector()

vsf_err_t vsf_flash_read_one_sector	(	vsf_flash_t *	flash_ptr,
		vsf_flash_size_t	offset_of_bytes,
		uint8_t *	buffer,
		vsf_flash_size_t	size_of_bytes
	)

flash read one sector

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	offset_of_bytes	Address of the sector to be written, some flash requires an integer multiple of the smallest writable sector size
[in]	buffer	a pointer to data
[in]	size_of_bytes	a pointer to data

Returns

vsf_err_t: VSF_ERR_NONE if flash starts to perform the chip erase, or a negative error code

vsf_flash_read_multi_sector()

vsf_err_t vsf_flash_read_multi_sector	(	vsf_flash_t *	flash_ptr,
		vsf_flash_size_t	offset_of_bytes,
		uint8_t *	buffer,
		vsf_flash_size_t	size_of_bytes
	)

flash read multi sector

Parameters

[in]	flash_ptr	a pointer to structure vsf_flash_t
[in]	offset_of_bytes	Address of the sector to be written, some flash requires an integer multiple of the smallest writable sector size
[in]	buffer	a pointer to data
[in]	size_of_bytes	a pointer to data

Returns

vsf_err_t: VSF_ERR_NONE if flash starts to perform the chip erase, or a negative error code