SNIP_CLASSIC_ADC_SECTION_8_3_11_Adc_GetGroupStatus

8.3.11 Adc_GetGroupStatus [SWS_Adc_00374] Definition of API function Adc_GetGroupStatus ⌈ Service Name Adc_GetGroupStatus Syntax Adc_StatusType Adc_GetGroupStatus ( Adc_GroupType Group ) Service ID [hex] 0x09 Sync/Async Synchronous Reentrancy Reentrant Parameters (in) Group Numeric ID of requested ADC Channel group. Parameters (inout) None Parameters (out) None Return value Adc_StatusType Conversion status for the requested group. Description Returns the conversion status of the requested ADC Channel group. Available via Adc.h ⌋ [SWS_Adc_00220] Upstream requirements: SRS_Adc_12291 ⌈The function Adc_GetGroupStatus shall return the conversion status of the requested ADC Channel group.⌋ [SWS_Adc_00221] Upstream requirements: SRS_BSW_00335, SRS_Adc_12291 ⌈The function Adc_GetGroupStatus shall return ADC_IDLE: • If Adc_GetGroupStatus is called before the conversion of the requested group has been started • For groups with trigger source software: If Adc_GetGroupStatus is called after the conversion was stopped with Adc_StopGroupConversion • In continuous group conversion mode with linear streaming access mode: If Adc_ GetGroupStatus is called after calling Adc_GetStreamLastPointer (group was in state ADC_STREAM_COMPLETED while calling Adc_GetStreamLastPointer). • In continuous group conversion mode with linear streaming access mode: If Adc_ GetGroupStatus is called after calling Adc_ReadGroup (group was in state ADC_ STREAM_COMPLETED while calling Adc_ReadGroup). • In one-shot SW conversion mode: If Adc_GetGroupStatus is called after calling Adc_GetStreamLastPointer. • In one-shot SW conversion mode: If Adc_GetGroupStatus is called after calling Adc_ReadGroup. • For groups with trigger source hardware: If Adc_GetGroupStatus is called after calling Adc_DisableHardwareTrigger • For groups with trigger source hardware and linear streaming access mode: If Adc_GetGroupStatus is called after calling Adc_GetStreamLastPointer (group was in state ADC_STREAM_COMPLETED while calling Adc_GetStreamLast Pointer). • For groups with trigger source hardware and linear streaming access mode: If Adc_GetGroupStatus is called after calling Adc_ReadGroup (group was in state ADC_STREAM_COMPLETED while calling Adc_ReadGroup). ⌋ [SWS_Adc_00222] Upstream requirements: SRS_BSW_00335, SRS_Adc_12291 ⌈The function Adc_GetGroupStatus shall return ADC_BUSY: • If it is called while the first conversion round of the requested group is still ongoing (continuous conversion mode). • Once trigger is enabled for group with HW trigger source. • Once Adc_StartGroupConversion is called for group with SW trigger source. • In continuous group conversion mode with single access mode: If Adc_GetGroup Status is called after calling Adc_GetStreamLastPointer • In continuous group conversion mode with single access mode: If Adc_GetGroup Status is called after calling Adc_ReadGroup. • In continuous group conversion mode with circular streaming access mode: If Adc_GetGroupStatus is called after calling Adc_GetStreamLastPointer • In continuous group conversion mode with circular streaming access mode If Adc_GetGroupStatus is called after calling Adc_ReadGroup. • In continuous group conversion mode with linear streaming access mode: If Adc_ GetGroupStatus is called after calling Adc_GetStreamLastPointer (group was in state ADC_COMPLETED while calling Adc_GetStreamLastPointer). • In continuous group conversion mode with linear streaming access mode: If Adc_ GetGroupStatus is called after calling Adc_ReadGroup (group was in state ADC_ COMPLETED while calling Adc_ReadGroup). • In one-shot HW conversion mode and single access mode: If Adc_GetGroup Status is called after calling Adc_GetStreamLastPointer. • In one-shot HW conversion mode and single access mode: If Adc_GetGroup Status is called after calling Adc_ReadGroup. • In one-shot HW conversion mode and circular streaming access mode: If Adc_ GetGroupStatus is called after calling Adc_GetStreamLastPointer. • In one-shot HW conversion mode and circular streaming access mode: If Adc_GetGroupStatus is called after calling Adc_ReadGroup. • In one-shot HW conversion mode and linear streaming access mode: If Adc_ GetGroupStatus is called after calling Adc_GetStreamLastPointer (group was in state ADC_COMPLETED while calling Adc_GetStreamLastPointer). • In one-shot HW conversion mode and linear streaming access mode: If Adc_GetGroupStatus is called after calling Adc_ReadGroup (group was in state ADC_COMPLETED while calling Adc_ReadGroup).⌋ [SWS_Adc_00224] Upstream requirements: SRS_BSW_00335, SRS_Adc_12291 ⌈The function Adc_GetGroupStatus shall return ADC_COMPLETED: • If it is called after a conversion round (not the final one) of the requested group has been finished. ⌋ [SWS_Adc_00325] Upstream requirements: SRS_Adc_12291 ⌈The function Adc_GetGroupStatus shall return ADC_STREAM_COMPLETED: • If it is called in single access mode after one conversion round is completed. • If it is called in streaming access mode after the number of conversion rounds of the requested group have been finished, to fill the streaming buffer completely. ⌋ [SWS_Adc_00226] Upstream requirements: SRS_Adc_12291 ⌈The function Adc_GetGroupStatus shall provide atomic access to the status data by the use of atomic instructions.⌋ [SWS_Adc_00305] ⌈To guarantee consistent returned values, it is assumed that ADC group conversion is always started (or enabled in case of HW group) successfully by SW before status polling begins.⌋ [SWS_Adc_00225] Upstream requirements: SRS_BSW_00323, SRS_BSW_00386, SRS_SPAL_12448 ⌈If development error detection for the ADC module is enabled: if the channel group ID is non-existing, the function Adc_GetGroupStatus shall raise development error ADC_ E_PARAM_GROUP and return ADC_IDLE without any action.⌋ . [SWS_Adc_00301] Upstream requirements: SRS_BSW_00406 ⌈If development error detection for the ADC module is enabled: if called prior to initializing the ADC module, Adc_GetGroupStatus shall raise development error ADC_E_ UNINIT and return ADC_IDLE without any action.⌋ [SWS_Adc_00436] ⌈In case of an aborted/suspended group, the state of the queued group remains the same as it was before the group was aborted/suspended.⌋