* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_ain_init();
* Read and update analog cached values.
*
* @return SUCCESS when transaction was successful.\n
- * FAILURE if transaction could not be confirmed.
+ * FAILURE if transaction could not be confirmed.
*/
int8_t rpp_ain_update();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_aout_init();
* Flush cached output values.
*
* @return SUCCESS when transaction was successful.\n
- * FAILURE if transaction could not be confirmed.
+ * FAILURE if transaction could not be confirmed.
*/
int8_t rpp_aout_update();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_din_init();
*
* @param[in] pin The pin number to read [1-16].
* @param[in] var_thr TRUE to read from variable threshold uncached high speed
- * channel. Note that only inputs [9-16] can use this
- * option. Inputs [9-12] use variable threshold B and
- * [13-16] use variable threshold B.
+ * channel. See rpp_din_ref().\n
+ * Note that only inputs [9-16] can use this option.\n
+ * Inputs [9-12] use variable threshold B and [13-16] use
+ * variable threshold B.\n
* FALSE to read from SPI cached value. All pins can use
- * this option. See rpp_din_ref().
+ * this option.
*
* @return HIGH or LOW if successful.\n
* -1 if pin number is out of range.\n
* changes on pin configurations.
*
* @return SUCCESS when transaction was successful.\n
- * FAILURE if transaction could not be confirmed.
+ * FAILURE if transaction could not be confirmed.
*/
int8_t rpp_din_update();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_eth_init();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_fr_init();
*
* @param[in] period Period of the PWM in microseconds (us). If period is
* less than 1 (the minimum, see note below) the default of
- * ~18kHz (18181.818181818 Hz to be precise) is used.
+ * 55us (~18kHz, 18181.8181_ Hz to be precise) is used.
*
* @return SUCCESS if successful.\n
* FAILURE if H-Bridge was already enabled or watchdog task could not
*
* @note Period considerations from Software perspective (hardware verification
* required):
- *
+ * @par
* - Minimum value is [1us]:
* - 1us = 0.001 ms =>
* - 1000000 Hz = 1 MHz
* - A pulse of 1% of the duty cycle -> 100 MHz (X)
* - System clock is 80MHz.
- *
+ * @par
* - Maximum value is [2147483647us] (full 32bit signed integer):
* - 2147483647us = 2147483.647 ms = 2147.483647 s =
* ~35.791394 min => 0.000465661129 Hz -> 0.0... MHz
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_hout_init();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_lin_init();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_lout_init();
* Flush cached output values and read back diagnostic values of all pins.
*
* @return SUCCESS when transaction was successful.\n
- * FAILURE if transaction could not be confirmed.
+ * FAILURE if transaction could not be confirmed.
*/
int8_t rpp_lout_update();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_mout_init();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_sci_init();
* Default is 9600. If 0 is provided default is used.
*
* @return TRUE if baud rate is a known value.\n
- * FALSE otherwise.
+ * FALSE otherwise.
*/
boolean_t rpp_sci_setup(uint32_t baud);
* @param[out] buffer Pointer to buffer where to store data.
*
* @return SUCCESS if the requested amount of data could be transfered.\n
- * FAILURE if requested amount of data is unavailable.
+ * FAILURE if requested amount of data is unavailable.
*/
int8_t rpp_sci_read_nb(uint32_t amount, uint8_t* buffer);
* @param[in] data Pointer to buffer from where to read data.
*
* @return SUCCESS if the requested amount of data could be transfered to the
- * output buffer.\n
- * FAILURE if the SCI output buffer was locked by another process or
- * not all the bytes requested to send could be transfered.
+ * output buffer.\n
+ * FAILURE if the SCI output buffer was locked by another process or
+ * not all the bytes requested to send could be transfered.
*/
int8_t rpp_sci_write_nb(uint32_t amount, uint8_t* data);
* FALSE to flush outgoing buffer.
*
* @return SUCCESS if flushed buffer had some data.\n
- * FAILURE if flushed buffer had no data left.
+ * FAILURE if flushed buffer had no data left.
*/
int8_t rpp_sci_flush(boolean_t buff);
* user expecting to run in Simulation should always check for FAILURE.
*
* @return [0-255] The byte read from the SCI input buffer.\n
- * FAILURE If and error occurred.
+ * FAILURE If and error occurred.
*/
int16_t rpp_sci_getc();
* Call this method before using this module.
*
* @return SUCCESS if initialization successful.\n
- * FAILURE if module already initialized.
+ * FAILURE if module already initialized.
*/
int8_t rpp_sdc_init();
projects / pes-rpp / rpp-lib.git / commitdiff