Go to the source code of this file.
Typedefs | |
| typedef enum CAM_FSYNC_STATUS | CAM_FSYNC_STATUS |
| Status codes for fsync group program start time operation. More... | |
Enumerations | |
| enum | CAM_FSYNC_STATUS { CAM_FSYNC_OK = 0, CAM_FSYNC_GROUP_BUSY, CAM_FSYNC_GROUP_NOT_FOUND, CAM_FSYNC_GROUP_FAULT, CAM_FSYNC_ERROR, CAM_FSYNC_UNSUPPORTED, CAM_FSYNC_GROUP_IDLE, CAM_FSYNC_INVALID_CONFIG, CAM_FSYNC_GENERATOR_NOT_FOUND } |
| Status codes for fsync group program start time operation. More... | |
Functions | |
| CAM_FSYNC_STATUS | cam_fsync_program_abs_start_value (uint32_t group_id, uint64_t start_time_in_tsc_ticks) |
| Program and start generators in group with absolute start time in TSC ticks. More... | |
| CAM_FSYNC_STATUS | cam_fsync_stop_group (uint32_t group_id) |
| Stop all generators in the requested group. More... | |
| CAM_FSYNC_STATUS | cam_fsync_reconfigure_generator (uint32_t group_id, uint32_t generator_id, uint32_t frequency_hz, uint32_t duty_cycle, uint32_t offset_ms) |
| Reconfigure the period, duty cycle, and relative offset of a given generator. More... | |
| typedef enum CAM_FSYNC_STATUS CAM_FSYNC_STATUS |
Status codes for fsync group program start time operation.
| enum CAM_FSYNC_STATUS |
Status codes for fsync group program start time operation.
Definition at line 23 of file NvCamFsync.h.
| CAM_FSYNC_STATUS cam_fsync_program_abs_start_value | ( | uint32_t | group_id, |
| uint64_t | start_time_in_tsc_ticks | ||
| ) |
Program and start generators in group with absolute start time in TSC ticks.
This function programs and start all the generator in group identified by group ID at an absolute start time given in TSC ticks.
| [in] | group_id | Group id for the node Valid range: [ MIN_GROUP_ID_DEFINED_IN_DT, MAX_GROUP_ID_DEFINED_IN_DT] |
| [in] | start_time_in_tsc_ticks | Start time in TSC ticks to program generators in group Valid range: [ TSC_CURRENT_TICKS, MAX_UINT64] |
| CAM_FSYNC_OK | Success to program and start fsync in group_id with start_time_in_tsc_ticks |
| Error | status defined in CAM_FSYNC_STATUS. |
Usage considerations
| CAM_FSYNC_STATUS cam_fsync_reconfigure_generator | ( | uint32_t | group_id, |
| uint32_t | generator_id, | ||
| uint32_t | frequency_hz, | ||
| uint32_t | duty_cycle, | ||
| uint32_t | offset_ms | ||
| ) |
Reconfigure the period, duty cycle, and relative offset of a given generator.
| [in] | group_id | Group id for the node Valid range: [MIN_GROUP_ID_DEFINED_IN_DT, MAX_GROUP_ID_DEFINED_IN_DT] |
| [in] | generator_id | ID of the generator within the group. The ID of a generator is its index within the group (defined in DT). Valid range: [MIN_GENERATOR_ID_DEFINED_IN_DT, MAX_GENERATOR_ID_DEFINED_IN_DT] |
| [in] | frequnecy_hz | The new frequency, in Hz. On Linux, all generators within the group must have a least-common-multiple frequency not greater than 120Hz. On QNX, all generators must not be greater than 120Hz and rational multiples of the highest frequency. Valid range: [> 0, 120] |
| [in] | duty_cycle | The new duty cycle, in whole percent. Valid range: [> 0, < 100] |
| [in] | offset_ms | The new relative offset, in milliseconds. Value range: [non-zero] |
| CAM_FSYNC_OK | The requested generator was successfully reconfigured. |
| CAM_FSYNC_GROUP_BUSY | The group is not stopped - the generator cannot be reconfigured. |
| CAM_FSYNC_INVALID_CONFIG | The input frequency, duty cycle, or relative offset is out-of-range. The input frequency, duty cycle, or relative offset conflicts with other generators in the group. |
| CAM_FSYNC_GROUP_NOT_FOUND | The input group ID was not found. |
| CAM_FSYNC_GENERATOR_NOT_FOUND | The input generator ID was not found. |
| CAM_FSYNC_ERROR | A generic error occurred. |
Usage considerations
| CAM_FSYNC_STATUS cam_fsync_stop_group | ( | uint32_t | group_id | ) |
Stop all generators in the requested group.
| [in] | group_id | Group id for the node Valid range: [ MIN_GROUP_ID_DEFINED_IN_DT, MAX_GROUP_ID_DEFINED_IN_DT] |
| CAM_FSYNC_OK | Successfully stopped all generators in the requested group. |
| CAM_FSYNC_GROUP_IDLE | Failed to stop the generators - the group is already stopped. |
| CAM_FSYNC_GROUP_NOT_FOUND | The input group ID was not found. |
| CAM_FSYNC_ERROR | A generic error occurred. |
Usage considerations