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

Fix doxygen errors

This commit is contained in:
George Oikonomou 2018-03-02 18:06:19 +00:00 committed by Xenofon (Fontas) Fafoutis
parent 2a7e9f0835
commit fe05c6f865
2 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
os/dev/spi-hal.c
View File

@ -28,7 +28,15 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/*---------------------------------------------------------------------------*/
/**
* \addtogroup spi-hal
* @{
*
* \file
* Implementation of the platform-independent aspects of the SPI HAL
*/
/*---------------------------------------------------------------------------*/
#include "spi-hal.h" #include "spi-hal.h"
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
@ -223,3 +231,6 @@ spi_strobe(spi_device_t *dev, uint8_t strobe, uint8_t *result)
return spi_arch_transfer(dev, &strobe, 1, result, 1, 0); return spi_arch_transfer(dev, &strobe, 1, result, 1, 0);
} }
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/**
* @}
*/

14
os/dev/spi-hal.h
View File

@ -73,6 +73,7 @@ typedef enum {
SPI_DEV_STATUS_BUS_NOT_OWNED, /* SPI bus is locked by someone else */ SPI_DEV_STATUS_BUS_NOT_OWNED, /* SPI bus is locked by someone else */
SPI_DEV_STATUS_CLOSED /* SPI bus has not opened properly */ SPI_DEV_STATUS_CLOSED /* SPI bus has not opened properly */
} spi_status_t; } spi_status_t;
/** @} */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/** /**
* \brief SPI Device Configuration * \brief SPI Device Configuration
@ -92,7 +93,7 @@ typedef struct spi_device {
uint8_t spi_pol; /* SPI mode polarity */ uint8_t spi_pol; /* SPI mode polarity */
uint8_t spi_controller; /* ID of SPI controller to use */ uint8_t spi_controller; /* ID of SPI controller to use */
} spi_device_t; } spi_device_t;
/** @} */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
/* These are architecture-independent functions to be used by SPI devices. */ /* These are architecture-independent functions to be used by SPI devices. */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
@ -201,11 +202,11 @@ spi_status_t spi_read_skip(spi_device_t *dev, int size);
* \param dev An SPI device configuration. * \param dev An SPI device configuration.
* \param data A pointer to the data to be written. Set it to NULL to * \param data A pointer to the data to be written. Set it to NULL to
* skip writing. * skip writing.
* \param wlen Size of data to write. * \param wsize Size of data to write.
* \param buf A pointer to buffer to copy the data read. Set to NULL * \param buf A pointer to buffer to copy the data read. Set to NULL
* to skip reading. * to skip reading.
* \param rlen Size of data to read. * \param rsize Size of data to read.
* \param ignore_len Size of data to read and ignore. * \param ignore Size of data to read and ignore.
* \return SPI return code * \return SPI return code
* *
* It should work only if the device has already locked the SPI controller. * It should work only if the device has already locked the SPI controller.
@ -347,3 +348,8 @@ spi_status_t spi_arch_select(spi_device_t *dev);
spi_status_t spi_arch_deselect(spi_device_t *dev); spi_status_t spi_arch_deselect(spi_device_t *dev);
#endif /* SPI_HAL_H_ */ #endif /* SPI_HAL_H_ */
/*---------------------------------------------------------------------------*/
/**
* @}
* @}
*/