Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation in hw_api.h. #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated documentation in hw_api.h. #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions hw_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ extern "C" {
#include <stdint.h>
#include <stdbool.h>

/* HAL_SPI_Enable() is to drive the CS Pin to the eve HIGH */
/* HAL_SPI_Enable() is to drive the CS Pin to the eve LOW */
void HAL_SPI_Enable(void);

/* HAL_SPI_Disable() is to drive the CS Pin to the eve LOW */
/* HAL_SPI_Disable() is to drive the CS Pin to the eve HIGH */
void HAL_SPI_Disable(void);

/* HAL_SPI_Write(uint8_t data) does a single byte SPI write transfer */
Expand All @@ -19,13 +19,17 @@ uint8_t HAL_SPI_Write(uint8_t data);
/* HAL_SPI_WriteBuffer does a buffer based SPI Write transfer */
void HAL_SPI_WriteBuffer(uint8_t *Buffer, uint32_t Length);

/* HAL_SPI_WriteBuffer does a buffer based SPI Read transfer */
/* HAL_SPI_WriteBuffer does a buffer based SPI Read transfer.
Must read and discard one byte before reading Length bytes and
storing them in Buffer.*/
void HAL_SPI_ReadBuffer(uint8_t *Buffer, uint32_t Length);

/* Stall the cpu for X milliseconds */
void HAL_Delay(uint32_t milliSeconds);

/* Gives an opertunity to reset the EVE hardware */
/* Gives an opertunity to reset the EVE hardware.
Must drive RST (PD) line low for 50 ms and then
high for at least 100 ms. */
void HAL_Eve_Reset_HW(void);

/* Cleans up and resources allocated */
Expand Down