14.7.3.2.3 Function rtc_count_set_compare()
Set the compare value for the specified compare.
enum status_code rtc_count_set_compare( struct rtc_module *const module, const uint32_t comp_value, const enum rtc_count_compare comp_index)
Sets the value specified by the implementer to the requested compare.
Note: Compare 4 and 5 are only available in 16-bit mode.
| Data direction | Parameter name | Description |
|---|---|---|
|
[in, out] |
module |
Pointer to the software instance struct |
|
[in] |
comp_value |
The value to be written to the compare |
|
[in] |
comp_index |
Index of the compare to set |
Returns
Status indicating if compare was successfully set.
| Return value | Description |
|---|---|
|
STATUS_OK |
If compare was successfully set |
|
STATUS_ERR_INVALID_ARG |
If invalid argument(s) were provided |
|
STATUS_ERR_BAD_FORMAT |
If the module was not initialized in a mode |