GPT Driver (Gpt)

Returns the version information of this module.

Initializes the GPT driver.

Deinitializes the GPT driver.

Returns the time already elapsed.

Returns the time remaining until the target time is reached.

Starts a timer channel.

Stops a timer channel.

Enables the interrupt notification for a channel (relevant in normal mode).

Disables the interrupt notification for a channel (relevant in normal mode).

Sets the operation mode of the GPT.

Disables the wakeup interrupt of a channel (relevant in sleep mode).

Enables the wakeup interrupt of a channel (relevant in sleep mode).

-

Checks if a wakeup capable GPT channel is the source for a wakeup event and calls the ECU state manager service Ecu M_ Set Wakeup Event in case of a valid GPT channel wakeup event.

Delivers the current value of the desired GPT Predef Timer.

This is the type of the data structure including the configuration set required for initializing the GPT timer unit.

Numeric ID of a GPT channel.

Type for reading and setting the timer values (in number of ticks).

Modes of the GPT driver.

Type for GPT Predef Timers

The function Gpt_Init shall initialize the hardware timer module according to a configuration set referenced by ConfigPtr .

The function Gpt_DeInit shall deinitialize the hardware used by the GPT driver (de pending on configuration) to the power on reset state. Values of registers which are not writeable are excluded. It’s the responsibility of the hardware design that the state does not lead to undefined activities in the µC.

The function Gpt_GetTimeElapsed shall return the time already elapsed. When the channel is in mode “one - shot mode”, this is the value relative to the point in time, the channel has been started.

The function Gpt_StopTimer s hall stop the selected timer channel.

The function Gpt_EnableNotification shall enable the interrupt notification of the referenced channel configured for notification (see also SWS_Gpt_00233 ). The function shall save an att ribute like "notification enabled" of the channel.

The function Gpt_DisableNotification shall disable the interrupt notification of the referenced channel configured for notification (see also SWS_Gpt_00233 ). The function shall save an attribute like "notification disabled" of the channel.

The function Gpt_Init shall only initialize the configured resources. Resources that are not configured in the configuration file shall not be touched.

The f unction Gpt_GetTimeRemaining shall return the timer value remaining until the target time will be reached next time. The remaining time is the "target time" minus the time already elapsed.

If th e function Gpt_StartTimer is called on a channel in state "running", the function shall raise the runtime error GPT_E_BUSY .

The callback notifications Gpt_Notification_<channel> shall be configurable as pointers to user defined functions within the configuration structure.

When disabled, the GPT Driver will send no notification.

If development error detection is enabled for GPT modul e : I f the function Gpt_StopTimer is called on a channel in state "initialized", "stopped" or "expired", the function shall not raise a development error.

The function Gpt_DeInit shall disable all interrupt notifications and wakeup interrupts, controlled by the GPT driver.

The function Gpt_Init shall disable a ll interrupt notifications, controlled by the GPT driver.

The function Gpt_GetTimeElapsed shall be fully reentrant, this means e ven for the same timer channel.

The function Gpt_GetTimeRemaining shall be fully reentrant, this means even for the same timer channel.

The function Gpt_StartTimer shall be reentrant, if the timer channels used in concurrent calls are different.

The function Gpt_StopTimer shall be reentrant, if the timer channels used in concurrent calls are different.

The function Gpt_EnableNotification shall be reentrant, if the timer channels used in concurrent calls are different.

The function Gpt_DisableNotification shall be reentrant, if the timer channels used in concurrent cal ls are different.

If supported by hardware, a timer channel shall be able to be configured as wakeup source of the ECU. If enabled, the wakeup occurs when the target time is reached (timer value = target time).

The function Gpt_SetMode shall set the operation mode of the GPT driver to the given mode parameter.

If the parameter Mode has the value GPT_MODE_NORMAL: The function Gpt_SetMode shall enable the interrupt notification for all channels which are configured for notificatio n and the notification is enabled (stored attribute) via the function Gpt_EnableNotification prior. All other interrupt notifications shall be disabled.

If the parameter Mode has the value GPT_MODE_SLEEP : The function Gp t_SetMode shall enable the wakeup interrupts for all channels which are configured for wakeup and the wakeup is enabled (stored attribute) via the function Gpt_EnableWakeup prior . All other wakeup interrupts shall be disabled.

The function Gpt_DisableWakeup shall be reentrant, if the timer channels used in concurrent calls are different.

The function Gpt_EnableWakeup shall be reentrant , if the timer channels used in concurrent calls are different.

The function Gpt_DisableWakeup is only feasible, if GptReportWakeupSource is statically configured avail able.

The function Gpt_EnableWakeup is only feasible, if GptReportWakeupSource is statically configured available.

The function Gpt_DisableWakeup shall disable the wakeup interrupt of the referenced channel configured for wakeup. The function shall save an attribute like "wakeup disabled" of the channel. Comment: This attribute affec ts the wakeup interrupt always when the driver is in "sleep mode". In "normal mode" the attribute has no influence.

The function Gpt_EnableWakeup shall ena ble the wakeup interrupt of the referenced channel configured for wakeup. The function shall save an attribute like "wakeup enabled" of the channel.

The function Gpt_DeInit shall influence only the peripherals, which are alloc ated by the static configuration.

If the function Gpt_SetMode is called with parameter Mode has the value GPT_MODE_SLEEP : All timer channels in state "running" which are not configured for wakeup or not enabled for wakeup interruption (stored attribute) via Gpt_EnableWakeup shall be stopped and t heir state shall be changed to " stopped".

If the parameter Mode has the value GPT_MODE_NORMAL , the function Gpt_SetMode shall not restart automatically the timer channels which have been stopped by entering the sleep m ode.

If a timer channel is configured in "one - shot mode": If the timer has reached the target time (timer value = target time), the timer shall stop automatically and maintain its timer val ue unchanged. The channel state shall change from "running" to "expired".

If a timer channel is configured in "continuous mode": If the timer has reache d the target time (timer value = target time), the timer shall continue running with the value "0" at next timer tick. So, the time interval of the recurrence is: target time + 1. This interval shall be independently of implementation, e.g. interrupt delay s.

The function Gpt_DeInit shall be pre compile time configurable On/Off by the configuration parameter: GptDeInitApi .

The function Gpt_GetTimeElapsed shall be pre compile time configurable On/Off by the configuration parameter: GptTimeElapsedApi .

The function Gpt_GetTimeRemaining shall be pre compile time configurable On/Off by th e configuration parameter: GptTimeRemainingApi .

The function Gpt_EnableNotification shall be pre compile time configurable On/Off by the configura tion parameter: GptEnableDisableNotificationApi .

The function Gpt_DisableNotification shall be pre compile time configurable On/Off by the configuration parameter: GptEnableDisableNotificationApi .

The function Gpt_SetMode shall be pre compile time configurable On/Off by the configur ation parameter: GptWakeupFunctionalityApi .

The function Gpt_DisableWakeup shall be pre compile time configurable On/Off by the confi guration parameter: GptWakeupFunctionalityApi .

The function Gpt_EnableWakeup shall be pre compile time configurable On/Off by the configuration parameter: GptWakeupFunctionalityApi .

The ISR´s, providing the timer events, shall be responsible for resetting the interrupt flags (if needed by hardware) and calling the according notification function.

Each channel shall provide its own notification if configured.

If development error detection is enabled for GPT module : If the parameter Channel is invalid ( not within the range specified by configuration) , the function Gpt_GetTimeElapsed shall raise the error GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : If the parameter Channel is invalid ( not within the range specified by configuration), the function Gpt_GetTimeRemaining shall raise the error GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : If the parameter Channel is invalid (not within the range specified by configuration) , the function Gpt_StartTimer shall raise the err or GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : If the parameter Channel is invalid (not within the range specified by configuration) , the function Gpt_StopTimer shall raise the error GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : If the parameter Channel is invalid (not within the range specified by configuration) , the function Gpt_EnableNotification shall raise the error GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : If the parameter Channel is invalid (not within the range specified by configuration) or channel wakeup is not en abled by configuration (GptEnableWakeup), the function Gpt_DisableWakeup shall raise the error GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : If the parameter Channel is invalid (not within the range specified by configuration) or channel wakeup is not enabled by configuration (GptEnableWakeup), the function Gpt_EnableWakeup shall raise the error GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : If the parameter Channel is invalid (not within the range specified by configuration), the function Gpt_DisableNotification shall raise the error GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : The function Gpt_StartTimer shall raise the error GPT_E_PARAM_VALUE if the parameter Value is " 0 " or not within the allowed range (exceeding the maxi mum timer resolution) .

If development er ror detection is enabled for the GPT module : I f the driver is not initialized, t he function Gpt_DeInit shall raise the error GPT_E_UNINIT .

If development error detection is e nabled for GPT module : I f the driver is not initialized, the function Gpt_GetTimeElapsed shall raise the error GPT_E_UNINIT .

If development error detection is enabled for GPT module : If the driver is not initialized, the function Gpt_GetTimeRemaining shall raise the error GPT_E_UNINIT .

If development error detection is enabled for GPT module : If the driver is not initialized, the function Gpt_StartTimer shall raise the error GPT_E_UNINIT .

If development err or detection is enabled for GPT module : If the driver is not initialized, the function Gpt_StopTimer shall raise the error GPT_E_UNINIT .

If development error detection is enabled for GPT module : If the driver is not initialized, the function Gpt_EnableNotification shall raise the error GPT_E_UNINIT .

If development error detectio n is enabled for GPT module : If the driver is not initialized, the function Gpt_DisableNotification shall raise the error GPT_E_UNINIT .

If development error detection is enabled for GPT modul e : If the driver is not initialized, the function Gpt_SetMode shall raise the error GPT_E_UNINIT .

If development error detection is enabled for GPT module : If the driver is not initialized, the function Gpt_Disabl eWakeup shall raise the error GPT_E_UNINIT .

If development error detectio n is enabled for GPT module : If the driver is not initialized, the function Gpt_EnableWakeup shall raise the error GPT_E_UNINIT .

If developm ent error detection is enabled for GPT modul e : The function Gpt_SetMode shall raise the error GPT_E_PARAM_MODE if the parameter Mode is invalid .

The GP T Driver shall invoke a notification whenever the defined target time of the channel is reached.

I f any timer channel is in state "running", t he function Gpt_DeInit shall raise the runtime error GPT_E_BUSY .

The function Gpt_SetMode is only available if t he configuration parameter GptReportWakeupSource is enabled.

The function Gpt_Init shall disable all wakeup interrupts, controlled by the GPT driver.

Gpt_Irq.c shall include Gpt.h for the prototype declaration of the notification functions.

Within one container it shall not be possible to mix parameters assigned to different configuration classes.

The function Gpt_StartTimer shall start the selected timer channel with a defined target time.

If configured and enabled, an interrupt notification or a wakeup interrupt occurs, when th e target time is reached .

Module Header File Imported Type Ecu M Ecu M.h Ecu M _ Wakeup Source Type Std Std_ Types.h Std _ Return Type Std_ Types.h Std _ Version Info Type

If the function Gpt_GetTimeElapsed is called on a timer channel in state "initialized" (channel started never before), the functio n shall return the value " 0 ".

If the function Gpt_GetTimeElapsed is called on a timer channel in state "stopped", the function shall return the time value at the moment of stopping.

If the function Gpt_GetTim eElapsed is called on a channel configured for "one - shot mode" in state "expired" (timer has reached the target time), the function shall return the target time .

If the function Gpt_GetTimeRema ining is called on a timer channel in state "initialized" (channel started never before), the function shall return the value " 0 ".

If the function Gpt_GetTimeRemaining is called on a timer channel in state "stopped", the function sh all return the remaining time value at the moment of stopping .

If the function Gpt_GetTimeRemaining is called on a channel configured for "one - shot mode" in state "expired" (timer has reached the target time), the function shall ret urn the value “ 0 ”.

If development error detection is enabled for the GPT module : If the GPT driver is not in operation mode "uninitialized", the function Gpt_Init shall raise the error GPT_E_ALREADY_INITIALIZED .

If a postbuild multiple selectable configuration variant was used, the function Gpt_DeInit shall further influence only the peripherals, which are allocated by the runtime configuration set passed by the previous call of the function Gpt_Init .

A re - initialization of the GPT driver by executing the Gpt_Init function requires a de - initialization before by executing a Gpt_DeInit .

The function Gpt_CheckWakeup shall check if a wakeup capable GPT channel is the source for a wakeup event and call EcuM_SetWakeupEvent to indicate a valid timer wakeup event to the ECU State Manager [8] .

The function Gpt_CheckWakeup is only feasible, if GptReportWakeupSource is statically configured available.

The function Gpt_CheckWakeup shall be reentrant, by reason of possible usage in concurren t interrupt service routines.

The function Gpt_CheckWakeup shall be pre compile time configurable On/Off by the configuration parameter: GptWakeupFunctionalityApi .

If development error detection is enabled f or GPT module : If the driver is not initialized, the function Gpt_CheckWakeup shall raise the error GPT_E_UNINIT .

EcuM_CheckWakeup shall be called within the Interrupt Service Routi ne, servicing the GPT channel wakeup event on wakeup - capable channels.

The ISR´s, providing the wakeup events, shall be responsible for resetting the interrupt flags (if needed by hardware).

A timer channel starts counting at value zero.

If a timer channel is configured in "continuous mode": If supported by hardware, it shall be possible to realize a free running timer. This means: A timer which rolls over automatically by hardware, if the target time is set to the max imum value the timer is able to count (max value = 2 n - 1, n=number of bits).

I f supported by hardware, a timer channel shall be able to be configure d to call a notification function. If enabled, the function is called when the target time is reached (timer value = target time) .

If the GptDevErrorDetect switch is enabled: When a development error occurs the corresponding GPT function shall skip the desired functionality (leave service without any action).

If development error detection is enabled for the GPT module: If the parameter VersionInfoPtr is a null pointer, the function Gpt_GetVersionInfo shall raise the error GPT_E_PARAM_POINTER .

The function Gpt_Init shall set the operation mode of the GPT driver to "normal mode". This leads to a behavior like Gpt_SetMode is called with parameter GPT_MODE_NORMAL .

If the parameter has the value GPT_MODE_SLEEP the function Gpt_SetMode shall not start a wakeup timer automatically. First, the user shall call Gpt_StartTimer to start a wakeup timer, after this the user shall call Gpt_SetMode with parameter GPT_MODE_SLEEP .

The state of the selected timer channel shall be changed to "stopped" if Gpt_StopTimer is called.

If the function Gpt_StopTimer is called on a channel in state "initialized", "stop ped" or "expired", the function shall leave without any action (no change of the channel state).

If the hardware allows for only one usage of the register, the driver module implementing that functionality is responsible for initializing the register.

If the register can affect several hardware modules and if it is an I/O register it shall be initialized by the PORT driver.

If the register can affect sever al hardware modules and if it is not an I/O register it shall be initialized by the MCU driver.

One - time writable registers that require initialization directly after reset shall be initialized by the startup code.

All other registers shall be initialized by the startup code.

When the channel is in mode "continuous mode", the return value of Gpt_GetTimeElapsed is the value relative to the las t recurrence (target time reached) or to the start of the channel before the first recurrence occurs.

For all available channels, callback functions have to be declared by the configuration tool.

The functi on Gpt_DeInit shall set the operation mode of the GPT driver to "uninitialized".

The state of the selected timer channel shall be changed to "running" if Gpt_StartTimer is called.

Gpt.c shall include Det.h in any case to be able to raise runtime error.

If development error detection is enabled for GPT module : If no valid notification function is configured (GptNotification) , the function Gpt_EnableNotification shall raise the error GPT_E_PARAM_CHANNEL .

If development error detection is enabled for GPT module : If no valid notification funct ion is configured (GptNotification), the function Gpt_DisableNotification shall raise the error GPT_E_PARAM_CHANNEL .

The standardized common published parameters as required by SRS_BSW_00402 in the SRS General on Basic Software Modules [3] shall be published within the header file of this module and need to be provided in the BSW Module De scription. The according module abbreviation can be found in the List of Basic Software Modules [1] .

A GPT Predef Timer is a free running up counter (user point of view). If the timer has reached the maximum value (max value = 2 n - 1, n=number of bits), the timer shall continue running with the value "0" at next timer tick .

A GPT Predef Timer shall have a maximum tick tolerance of +/ - 1 tick to ensure accuracy of time based function ality.

It shall be possible to configure which GPT Predef Timers are enabled.

If a GPT Predef Timer is enabled, the timer(s) with the same tick duration and lower bit number(s) shall be enabled also .

The function Gpt_Init shall start all enabled GPT Predef Timers at value “0”.

The function Gpt_DeInit shall stop all enabled GPT Predef Timers.

If the parameter Mode has the value GPT_MODE_NORMAL: If the driver is in “sleep mode”, the function Gpt_SetMode shall restart all enabled GPT Predef Timers at value “0” .

If the parameter Mode has the value GPT_MODE_SLEEP: The function Gpt_SetMode shall stop all enabled GPT Predef Timers.

The function Gpt_GetPredefTimerValue shall return the current value of the GPT Predef Timer pa ssed by PredefTimer .

If the timer value of the function Gpt_GetPredefTimerValue is less than 32 bit (16bit or 24bit timer), the upper bits shall be filled with zero.

The function Gpt_GetPredefTime rValue shall be fully reentrant, this means even for the same GPT Predef Timer.

If development error detection is enabled for GPT module : I f the driver is not initialized, the function Gpt_ GetPredefTimerValue shall raise the error GPT_E_UNINIT .

If development error detection is enabled for GPT module : If the parameter PredefTimer is invalid, the function Gpt_GetPredefTimerValu e shall raise the development error GPT_E_PARAM_PREDEF_TIMER .

If development error detection is enabled for GPT module : If the GPT Predef Timer passed by the parameter PredefTimer is not enabled, the function Gpt_GetPred efTimerValue shall raise the development error GPT_E_PARAM_PREDEF_TIMER .

If the driver is in "sleep mode", the function Gpt_ GetPredefTimerValue shall raise the runtime error GPT_E_MODE .

I f the GPT driver is not initialized, in “sleep mode” or the GPT Predef Timer is not enabled, the function Gpt_ GetPredefTimerValue shall ret urn E_NOT_OK .

If development error de tection is enabled for GPT module : If the parameter TimeValuePtr is a null pointer, the function Gpt_GetPredefTimerValue shall raise the error GPT_E_PARAM_POINTER .

Det_ Report Run t imeError Service to report runtime errors.

Det_ReportError Det.h Service to report development errors. EcuM_CheckWakeup EcuM.h This function can be called to check the given wakeup sources. It will pass the argument to the integrator function EcuM_CheckWakeupHook. It can also be called by the ISR of a wakeup source to set up the PLL and check other wakeup sources that may be connected to the same interrupt. EcuM_SetWakeupEvent EcuM.h Sets the wakeup event. ⌋(SRS_SPAL_00157)

The G PT module shall reject configurations with partition mappings which are not supported by the implementation .

Type of error Related error code Error value API service called without module initialization GPT_ E_ UNINIT 0x0A API service for initialization called when already initialized GPT_ E_ ALREADY_ INITIALIZED 0x0D API error return code: Init function failed GPT_ E_ INIT_ FAILED 0x0E API parameter checking: invalid channel GPT_ E_ PARAM_ CHANNEL 0x14 API parameter checking: invalid value GPT_ E_ PARAM_ VALUE 0x15 API parameter checking: invalid pointer GPT_ E_ PARAM_ POINTER 0x16 API parameter checking: invalid Predef Timer GPT_ E_ PARAM_ PREDEF_ TIMER 0x17 API parameter checking: invalid mode GPT_ E_ PARAM_ MODE 0x1F

Type of error Related error code Error value API service called when timer channel is still busy (running) GPT_ E_ BUSY 0x0B API service called when driver is in wrong mode GPT_ E_ MODE 0x0C

The ECUC partitions referenced by GptKernelEcucPartitionRef shall be a subset of the ECUC partitions referenced by GptEcucPartitionRef.

The ECUC partitions referenced by GptGroupEcuc PartitionRef shall be a subset of the ECUC partitions referenced by GptEcucPartition Ref.

If GptEcucPartitionRef references one or more ECUC partitions, GptKernelEcucPartitionRef shall have a multiplicity of one and reference one of these ECUC partitions as well.

If GptEcucPartitionRef references one or more ECUC partitions, GptKernelEcucPartitionRef shal l have a multiplicity of greater than zero and reference one or several of these ECUC partitions as well.

In case of partition local timer resources, the module will operate as an independent instance in each of the partitions, means the called API w ill only target the partition it is called in.