giomba/nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ext-flash: doxygen errors fixed

Browse Source
This commit is contained in:
Xenofon (Fontas) Fafoutis 2018-04-04 12:23:53 +01:00
parent 629803c5e5
commit f91b223c57
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
arch/dev/ext-flash/ext-flash.h
View File

@ -49,14 +49,15 @@
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** /**
* \brief Initialize storage driver. * \brief Initialize storage driver.
* \param SPI bus configuration struct. NULL for default. * \param conf SPI bus configuration struct. NULL for default.
* \return True when successful. * \return True when successful.
*/ */
bool ext_flash_open(spi_device_t *conf); bool ext_flash_open(spi_device_t *conf);
/** /**
* \brief Close the storage driver * \brief Close the storage driver
* \param SPI bus configuration struct. NULL for default. * \param conf SPI bus configuration struct. NULL for default.
* \return True when successful.
* *
* This call will put the device in its lower power mode (power down). * This call will put the device in its lower power mode (power down).
*/ */
@ -64,7 +65,7 @@ bool ext_flash_close(spi_device_t *conf);
/** /**
* \brief Read storage content * \brief Read storage content
* \param SPI bus configuration struct. NULL for default. * \param conf SPI bus configuration struct. NULL for default.
* \param offset Address to read from * \param offset Address to read from
* \param length Number of bytes to read * \param length Number of bytes to read
* \param buf Buffer where to store the read bytes * \param buf Buffer where to store the read bytes
@ -76,7 +77,7 @@ bool ext_flash_read(spi_device_t *conf, uint32_t offset, uint32_t length, uint8_
/** /**
* \brief Erase storage sectors corresponding to the range. * \brief Erase storage sectors corresponding to the range.
* \param SPI bus configuration struct. NULL for default. * \param conf SPI bus configuration struct. NULL for default.
* \param offset Address to start erasing * \param offset Address to start erasing
* \param length Number of bytes to erase * \param length Number of bytes to erase
* \return True when successful. * \return True when successful.
@ -88,7 +89,7 @@ bool ext_flash_erase(spi_device_t *conf, uint32_t offset, uint32_t length);
/** /**
* \brief Write to storage sectors. * \brief Write to storage sectors.
* \param SPI bus configuration struct. NULL for default. * \param conf SPI bus configuration struct. NULL for default.
* \param offset Address to write to * \param offset Address to write to
* \param length Number of bytes to write * \param length Number of bytes to write
* \param buf Buffer holding the bytes to be written * \param buf Buffer holding the bytes to be written
@ -99,7 +100,7 @@ bool ext_flash_write(spi_device_t *conf, uint32_t offset, uint32_t length, const
/** /**
* \brief Initialise the external flash * \brief Initialise the external flash
* \param SPI bus configuration struct. NULL for default. * \param conf SPI bus configuration struct. NULL for default.
* *
* This function will explicitly put the part in its lowest power mode * This function will explicitly put the part in its lowest power mode
* (power-down). * (power-down).