Commit 1c901a50 authored by Thomas Schöpping's avatar Thomas Schöpping
Browse files

fixed alignment

parent 2d9a6d7f
......@@ -33,7 +33,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
/**
* @brief Realease type of this version.
* @note Possible values are "pre-alpha", "alpha", "beta", "release candidate", and "release".
* @note Possible values are "pre-alpha", "alpha", "beta", "release
* candidate", and "release".
*/
#define AMIROLLD_RELEASE_TYPE "beta"
......@@ -45,7 +46,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
/**
* @brief The AMiRo-LLD minor version.
* @note A higher minor version implies new functionalty, but all old interfaces are still available.
* @note A higher minor version implies new functionalty, but all old
* interfaces are still available.
*/
#define AMIROLLD_VERSION_MINOR 1
......@@ -64,7 +66,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
# if !defined(_AMIRO_LLD_CFG_)
# error "invalid AMiRo-LLD configuration file"
# elif (AMIRO_LLD_CFG_VERSION_MAJOR != AMIROLLD_VERSION_MAJOR) || (AMIRO_LLD_CFG_VERSION_MINOR < AMIROLLD_VERSION_MINOR)
# elif (AMIRO_LLD_CFG_VERSION_MAJOR != AMIROLLD_VERSION_MAJOR) || \
(AMIRO_LLD_CFG_VERSION_MINOR < AMIROLLD_VERSION_MINOR)
# error "incompatible AMiRo-LLD configuration file"
# endif
......
......@@ -105,7 +105,8 @@ extern "C" {
#if !defined(apalDbgAssertMsg) || defined(__DOXYGEN__)
/**
* @brief Assert function to check a given condition and print a message string.
* @brief Assert function to check a given condition and print a message
* string.
*
* @param[in] c The condition to check.
* @param[in] fmt Formatted message string to print.
......@@ -214,8 +215,8 @@ typedef uint8_t apalGpioState_t;
*
* @return Inverted physical GPIO state.
*/
#define APAL_GPIO_STATE_INVERT(state) ( \
(apalGpioState_t)state ^ APAL_GPIO_HIGH \
#define APAL_GPIO_STATE_INVERT(state) ( \
(apalGpioState_t)state ^ APAL_GPIO_HIGH \
)
/**
......@@ -267,11 +268,11 @@ typedef uint8_t apalGpioActive_t;
*
* @return Inverted active state.
*/
#define APAL_GPIO_ACTIVE_INVERT(active) ( \
(((apalGpioActive_t)active & APAL_GPIO_ACTIVE_LOW) ^ \
((apalGpioActive_t)active & APAL_GPIO_ACTIVE_HIGH)) ? \
((apalGpioActive_t)active ^ APAL_GPIO_ACTIVE_ANY) : \
((apalGpioActive_t)active) \
#define APAL_GPIO_ACTIVE_INVERT(active) ( \
(((apalGpioActive_t)active & APAL_GPIO_ACTIVE_LOW) ^ \
((apalGpioActive_t)active & APAL_GPIO_ACTIVE_HIGH)) ? \
((apalGpioActive_t)active ^ APAL_GPIO_ACTIVE_ANY) : \
((apalGpioActive_t)active) \
)
/**
......@@ -320,20 +321,22 @@ typedef uint8_t apalGpioEdge_t;
#define APAL_GPIO_EDGE_FALLING ((apalGpioEdge_t)2)
/**
* @brief Both rising and falling edges indicate an interrupt or trigger an action.
* @brief Both rising and falling edges indicate an interrupt or trigger an
* action.
*/
#define APAL_GPIO_EDGE_BOTH ((apalGpioEdge_t)3)
/**
* @brief Inverts the value of the informative or effective signal edge for interrupts.
* @brief Inverts the value of the informative or effective signal edge for
* interrupts.
* @details Rising edge is inverted to falling and vice versa.
* If none or both edges are enabled, the identical value is returned.
*/
#define APAL_GPIO_EDGE_INVERT(edge) ( \
(((apalGpioEdge_t)edge & APAL_GPIO_EDGE_RISING) ^ \
((apalGpioEdge_t)edge & APAL_GPIO_EDGE_FALLING)) ? \
((apalGpioEdge_t)edge ^ APAL_GPIO_EDGE_BOTH) : \
((apalGpioEdge_t)edge) \
#define APAL_GPIO_EDGE_INVERT(edge) ( \
(((apalGpioEdge_t)edge & APAL_GPIO_EDGE_RISING) ^ \
((apalGpioEdge_t)edge & APAL_GPIO_EDGE_FALLING)) ? \
((apalGpioEdge_t)edge ^ APAL_GPIO_EDGE_BOTH) : \
((apalGpioEdge_t)edge) \
)
/**
......@@ -397,7 +400,8 @@ extern "C" {
* @brief Return the interrupt enable status of the GPIO.
*
* @param[in] gpio GPIO to check.
* @param[out] enabled Flag, indicating whether interrupt is enabled for the GPIO.
* @param[out] enabled Flag, indicating whether interrupt is enabled for
* the GPIO.
*
* @return The status indicates whether the function call was successful.
*/
......@@ -433,7 +437,8 @@ extern "C" {
* @brief Enable or disable the interrupt event functionality.
*
* @param[in] cgpio Control GPIO to set.
* @param[in] enable Flag, indicating whether the interrupt shall be activated (true) or deactivated (false).
* @param[in] enable Flag, indicating whether the interrupt shall be
* activated (true) or deactivated (false).
*
* @return The status indicates whether the function call was successful.
*/
......@@ -655,9 +660,11 @@ extern "C" {
* @param[in] txbytes Number of bytes to send.
* @param[out] rxbuf Buffer to store a response to.
* @param[in] rxbytes Number of bytes to receive.
* @param[in] timeout Timeout for the function to return (in microseconds).
* @param[in] timeout Timeout for the function to return (in
* microseconds).
*
* @return The status indicates whether the function call was succesful or a timeout occurred.
* @return The status indicates whether the function call was succesful or a
* timeout occurred.
*/
apalExitStatus_t apalI2CMasterTransmit(apalI2CDriver_t* i2cd, const apalI2Caddr_t addr, const uint8_t* const txbuf, const size_t txbytes, uint8_t* const rxbuf, const size_t rxbytes, const apalTime_t timeout);
#endif
......@@ -670,9 +677,11 @@ extern "C" {
* @param[in] addr Address to read.
* @param[out] rxbuf Buffer to store the response to.
* @param[in] rxbytes Number of bytes to receive.
* @param[in] timeout Timeout for the function to return (in microseconds).
* @param[in] timeout Timeout for the function to return (in
* microseconds).
*
* @return The status indicates whether the function call was succesful or a timeout occurred.
* @return The status indicates whether the function call was succesful or a
* timeout occurred.
*/
apalExitStatus_t apalI2CMasterReceive(apalI2CDriver_t* i2cd, const apalI2Caddr_t addr, uint8_t* const rxbuf, const size_t rxbytes, const apalTime_t timeout);
#endif
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment