SNIP_CLASSIC_ADC_SECTION_8_3_6_Adc_ReadGroup

8.3.6 Adc_ReadGroup [SWS_Adc_00369] Definition of API function Adc_ReadGroup ⌈ Service Name Adc_ReadGroup Syntax Std_ReturnType Adc_ReadGroup ( Adc_GroupType Group, Adc_ValueGroupType* DataBufferPtr ) Service ID [hex] 0x04 Sync/Async Synchronous Reentrancy Reentrant Parameters (in) Group Numeric ID of requested ADC channel group. Parameters (inout) None Parameters (out) DataBufferPtr ADC results of all channels of the selected group are stored in the data buffer addressed with the pointer. Return value Std_ReturnType E_OK: results are available and written to the data buffer E_NOT_OK: no results are available or development error occured Description Reads the group conversion result of the last completed conversion round of the requested group and stores the channel values starting at the DataBufferPtr address. The group channel values are stored in ascending channel number order ( in contrast to the storage layout of the result buffer if streaming access is configured). Available via Adc.h ⌋ [SWS_Adc_00075] ⌈The function Adc_ReadGroup shall read the latest available conversion results of the requested group.⌋ [SWS_Adc_00113] Upstream requirements: SRS_SPAL_12063, SRS_Adc_12819, SRS_Adc_12292, SRS_Adc_- 12824 ⌈The function Adc_ReadGroup shall read the raw converted values without further scaling. The read values shall be aligned according the configuration parameter setting of ADC_RESULT_ALIGNMENT.⌋ [SWS_Adc_00122] Upstream requirements: SRS_Adc_12283, SRS_Adc_12819 ⌈If applicable, the function Adc_ReadGroup shall mask out all information or diagnostic bits provided by the conversion but not belonging to the conversion results themselves.⌋ [SWS_Adc_00329] Upstream requirements: SRS_Adc_12291 ⌈Calling function Adc_ReadGroup while group status is ADC_STREAM_COMPLETED shall trigger a state transition to ADC_BUSY for continuous conversion modes (single access mode or circular streaming buffer mode) and hardware triggered groups in single access mode or circular streaming access mode.⌋ [SWS_Adc_00330] Upstream requirements: SRS_Adc_12291 ⌈Calling function Adc_ReadGroup while group status is ADC_STREAM_COMPLETED shall trigger a state transition to ADC_IDLE for software triggered conversion modes which automatically stop the conversion (streaming buffer with linear access mode or one-shot conversion mode with single access) and for the hardware triggered conversion mode in combination with linear streaming access mode.⌋ [SWS_Adc_00331] Upstream requirements: SRS_Adc_12291 ⌈Calling function Adc_ReadGroup while group status is ADC_COMPLETED shall trigger a state transition to ADC_BUSY.⌋ [SWS_Adc_00359] ⌈The function Adc_ReadGroup shall be pre-compile configurable On/Off by the configuration parameter AdcReadGroupApi.⌋ [SWS_Adc_00388] ⌈When called while the group status is ADC_IDLE and the group conversion was not started (no results are available from previous conversions), the function Adc_ReadGroup shall report a runtime error ADC_E_IDLE.⌋ [SWS_Adc_00152] Upstream requirements: SRS_BSW_00323, SRS_BSW_00386, SRS_SPAL_12448 ⌈If development error detection for the ADC module is enabled: if the group ID is non-existing, the function Adc_ReadGroup shall raise development error ADC_E_PARAM_ GROUP and return E_NOT_OK.⌋ [SWS_Adc_00296] ⌈If development error detection for the ADC module is enabled: when called prior to initializing the driver, the function Adc_ReadGroup shall raise development error ADC_E_UNINIT and return E_NOT_OK.⌋