OCU Driver (Ocu)

Service for OCU initialization.

This function de - initializes the OCU module.

Service to start an OCU channel.

Service to stop an OCU channel.

Service to set immediately the level of the pin associated to an OCU channel.

Service to indicate the driver what shall be done automatically by hardware (if supported) upon compare match.

Service to read the current value of the counter.

Service to set the value of the channel threshold using an absolute input data.

Service to set the value of the channel threshold relative to the current value of the counter.

This service is used to disable notifications from an OCU channel.

This service is used to enable notifications from an OCU channel.

This service returns the version information of this module.

This notification function is called when a compare match occurs on the associated channel.

Numeric identifier of an OCU channel.

Type for reading the counter and writing the threshold values (in number of ticks).

Output state of the pin linked to an OCU channel.

Automatic action (by hardware) to be performed on a pin attached to an OCU channel. A vailable via Ocu.h

This is the type of the data structure containing the initialization data for the OCU driver.

Return information after setting a new threshold value.

Ocu .c shall include Ocu .h and Det.h .

If a free - running counter of the OCU cell can be used by another timer module then the Ocu driver must not start nor stop the free - running counter.

The API Ocu_Init shall start all free - running counters, which are exclusively used by this driver .

The O CU driver shall perform Inter Module Checks to avoid integration of incompatible files.The imported included files shall be checked by preprocessing directives. The following version numbers shall be verified: - <MODULENAME>_AR_RELEASE_MAJOR_VERSION - < MODULENAME>_AR_RELEASE_MINOR_VERSION Where <MODULENAME> is the module short name of the other (external) modules, which provide header files included by the OCU driver . If the values are not identical to the expected values, an error shall be reported.

All time units used within the API services of the OCU driver shall be of the unit ticks.

Development error values are of type uint8 .

The following errors shall be detectable by the OCU driver depending on its build version (development / production mode).

The detection of development errors is configurable ( ON / OFF ) at pre - compile time. The switch OcuDevErrorDetectApi shall activate or deactivate the detection of all development errors.

of the detected errors can be found in chapter Error classification and chapter API specification .

[SWS_Ocu_00020] ⌈The detection of production errors cannot be switched off.⌋ (SRS_BSW_00339)

Each variable that shall be accessible by AUTOSAR Debugging, shall be defined as global variable.

All type definitions of variables which shall be debugged shall be accessible by the header file O cu .h.

The declaration of variables in the header file shall be such that it is possible to calculate the size of the variables by C - "sizeof".

Variables available for debugging shall be described in the respective OCU driver Description.

Module Header File Imported Type Std Std_ Types.h Std _ Return Type Std_ Types.h Std _ Version Info Type

Ocu _ConfigType is a type of data structure containing the initialization data for the OCU driver. Mandatory parameters:  Symbolic name for channel / channel ID  maximum value of the counter  Time resolution in number of ticks  Notification function  Default value of the threshold  Minimu m v alue of the counter Optional parameters (if supported by hardware):  count direction  Ouput pin ( level s, and possible automatic actions).  Hardware triggered events (ADC or DMA) .  Microcontroller OCU - specific HW properties (optional prescaler , clock s ettings if supported by hardware) .

T he function Ocu _Init shall initialize all inte rnals variables and the used Ocu structure of the microcontroller according to a configuration set referenced by ConfigPtr .

t he function Ocu _Init shall only initialize the configured resources and shall not touch resources that are not configured in the configuration file.

If the hardware allows for only one usage of the register (register dedicated only to the OCU resource) , the n the OCU driver i s responsible for initializing the register.

The funct ion Ocu _Init shall stop all channels .

The function Ocu _Init shall disable all notifications.

If development error detection is enabled for the OCU driver and the function Ocu_Init is called when the OCU driver and hardware are already initialized, the function Ocu_Init shall raise development error OCU_E_ALREADY_INITIALIZED and return without any action .

A re - initialization of the OCU driver by executing the function Ocu_Init requires a de - initial ization before by executing the function Ocu_DeInit .

The function Ocu_DeInit shall deinitialize the OCU variables and registers that were initialized by Ocu_Init to a state comparable to their power on reset state. Values of registers which are not writeable are excluded.

The function Ocu_DeInit shall disable all used int errupt s and notifications .

The function Ocu_DeInit shall influence only the peripherals which are allocated by static configuration and/or the runtime configuration set passed by the previous ca ll of Ocu_Init() .

If development error detection is enabled for the OCU driver : If the driver is not initialized, the function Ocu _DeInit shall raise the error OCU _E_UNINIT .

The function Ocu_StartChannel shall start an OCU channel by allowing all compare match configured a ctions to be performed.

The function Ocu_StartChannel shall be reentrant if it is called for different channels.

The state of the selected channel shall be set to “RUN N I NG” If the function Ocu_StartChannel has been succe ss fully performed .

If the function Ocu_StartChannel is called on a channel in the state " RU N NING” , then the function shall raise the error OCU _E_BUSY and return without any action.

If development error detection is enabled for the OCU driver : If the parameter Channel Number is invalid (not within the range specified by the configuration), the function Ocu_StartChannel shall raise the error OCU _ E_PARAM_INVALID_CHANNEL and return without any action.

If development error detection is enabled for the OCU driver : If the driver is not initialized, the function Ocu_StartChannel shall raise the error OCU_ E_UNINIT and return without any action.

The function Ocu_St op Channel shall st op an OCU channel by halting compare match configured act ions for this channel.

The function Ocu_StopChannel shall not stop the free - running counter associated with a channel .

The function Ocu_St op Channel shall be reentrant if it is called for different channels.

The state of the selected channel shall be set to “ STOPPED”if the function Ocu_St op Channel is successfully performed .

I f the function Ocu_StopChannel is called on a channel in the state "STOPPED", then the function shall leave without any action (no change of the channel state), and shall not raise a development error.

If development error detection is enabled for the OCU driver : If the parameter ChannelNumber is invalid (not within the range specified by the configuration), the function Ocu_St op Channel shall raise the error OCU_ E_PARAM_INVALID_CHANNEL and return without any action.

If developm ent error detection is enabled for the OCU driver : If the driver is not initialized, the function Ocu_St op Channel shall raise the error OCU_ E_UNINIT and return without any action.

The function Ocu_SetPinState shall set the pin associated with the channel to the level indicated by “PinState” .

The fuction Ocu_SetPinState shall be reentrant if it is called for different channels.

The fu n ction Ocu_SetPinState shall be used on ly if the channel is not in the RUNNING state.

The function Ocu_SetPinState shall be pre compile time configurable On/Off by the configuration parameter: Ocu SetPinState Api {OCU_SET_PIN_STATE_API}.

If development error detection is enabled for the OCU driver : If the parameter ChannelNumber is invalid (not within the range specified by the configuration), the function Ocu_SetPinState shall raise the error OCU_ E_PARAM_INVALID_CHANNEL and return without any action.

If developmen t error detection is enabled for the OCU driver : If a pin is not associated with th e channel (not defined in the configuration of the channel ), the function Ocu_SetPinState shall raise the error OCU_E_PARAM_ NO _ PIN and return without any action.

If development error detection is enabled for the OCU driver : If the parameter PinState is invalid (not within the range specified by the configuration), the function Ocu_SetPinState shall raise the error OCU_E_PARAM_INVALID_ STATE and return without any action.

If development error detection is enabled for the OCU driver : If the driver is not initialized, the function Oc u_SetPinState shall raise the error OCU_ E_UNINIT and return without any action.

If development error detection is enabled for the OCU driver : If the channel is in the RUNNING state , the function Ocu_SetPinState shall raise the error OCU_E_PARAM_INVALID_STATE and return without any action.

The function Ocu_SetPinAction s hall set the action to be performed by hardware automatically , at the next compar e match in the corresponding OCU channel .

The fuction OCU Ocu_SetPinAction shall be reentrant if it is called for different channels.

The function Ocu_SetPinAction shall be pre compile time configurable by the configuration parameter: Ocu SetPinActionApi {OCU_SET_PIN_ACTION_API}.

If development error detection is enabled for the OCU driver : If the parameter ChannelNumber is invalid (not within the range specified by the configuration), the function Ocu_SetPinAction shall raise the error OCU_E_PARAM_INVALID_CHANNEL and return without any action.

If development error detection is enabled for the OCU driver : If a pin is not associated with th e channel (not defined in the configuration of the channel), the function Ocu_SetPin Action shall r aise the error OCU_E_PARAM_ NO _PIN and return without any action.

If development error detection is enabled for the OCU driver : If the parameter Pin Action is invalid (not within the range specified by the type ), the function Ocu_SetPin Action shall raise the error OCU_E_PARAM_INVALID_ ACTION and return without any action.

If development error detection is enabled for the OCU driver : If the driver is not initialized, the function Ocu_SetPinAction shall raise the error OCU_ E_UNINIT and return without any action.

If a pin is associated with a channel; the relevant action with this pin shall be performed upon compare match.

The function Ocu_GetCounter shall read and return the value of the counter of the channel indicated by ChannelNumber.

The function Ocu_GetCounter shall be re - entrant .

T he function Ocu_GetCounter shall be pre compile time configurable by the configuration parameter: OcuGetCounterApi {OCU_ GET_COUNTER_API }.

If development error detection is enabled for the OCU driver : If the parameter ChannelNumber is invalid (not within the range specified by the configuration), the function Ocu_GetCounter shall raise the error OCU_E_PARAM_INVALID_CHANNEL and shall return the value “ 0 ”.

If development error detection is enabled for the OCU driver : i f the driver is not initialized, then the function Ocu_GetCounterValue shall raise the error OCU_E_UNINIT and shall return the value “ 0 ”.

The function Ocu_Set Absolute Threshold shall set the channel threshold (the compare value) to the value given by AbsoluteValue .

The fuction Ocu_ SetAbsoluteThreshold shall be reentrant if it is called for different channels .

The function Ocu_SetAbsoluteThreshold shall be pre compile time configurable On/Off by the configuration parameter: OcuSetAbsoluteThresholdApi {OCU_ SET _ ABSOLUTE_THRESHOLD_API }.

If development error detection is enabled for the OCU dr iver : If the driver is not initialized, the function Ocu_SetAbsoluteThreshold shall raise the error OCU_E_UNINIT and return without any action.

If development error detection is enabled for the OCU driver : If the parameter ChannelNumber is invalid (not within the range specified by the configuration), the function Ocu _ SetAbsoluteThreshold shall raise the error OCU_E_PARAM_INVALID_CHANNEL and return without any action.

Upon actual setting of a new threshold value, the previous threshold value (written during the last call of this API) shall no longer produce a compare match.

After setting a new threshold value, the API Ocu_SetAbsoluteThreshold shall return a status to inform the caller whether the compare match will occur (or has already occured) during the current Reference Interval , as a result of setting the new threshold value.

The function Ocu_ Set Relative Threshold shall add RelativeValue to the value of the counter on entering the function to compute the new threshold relative to the counter .

The fuction OCU Ocu_SetAbsoluteThreshold shall be reentrant if it is called for different channels .

The function Ocu_SetRelativeThreshold shall be pre compile time configurable On/Off by the configuration parameter: Ocu SetRelative Threshold Api { OCU_SET_ RELATIVE_ THRESHOLD_API } .

If development error detection is enabled for the OCU driver : If the driver is not initialized, the function Ocu _ SetRelativeThreshold shall raise the error OCU_E_UNINIT and return without any action.

If development error detection is enabled for the OCU driver : i f the parameter ChannelNumber is invalid (not within the range specified by the configuration), the function Ocu_SetRelativeThreshold shall raise the error OCU_E_PARAM_INVALID_CHANNEL and return without any a ction.

After setting a new threshold value, the API Ocu_SetRelativeThreshold shall return a status to inform the caller whether the compare match will occur (or has already occured) during the current Reference Interval , as a result of setting the new threshold value.

Upon actual setting of a new threshold va lue (absolute or relative), the previous threshold value shall no longer produce a compare match.

The function Ocu _DisableNo tification shall disable the OCU compare match notification .

The fuction OCU Ocu_DisableNotification shall be reentrant if it is called for different channels .

The function Ocu _DisableNotification shall be pre compile time configurable On/Off by the configuration parameter: OcuNotificationSupported {OCU _NOTIFICATION_SUPPORTED}.

If development error detection is enabled for the OCU driver : If the driver is not initialized, the function Ocu _DisableNotification shall raise the error OCU _E_UNINIT and re t urn without any action.

If development error detection is enabled for the OCU driver : If the parameter Channel is invalid (not within the range specified by configuration), the function Ocu _DisableNotification shall raise the error OCU_E_PARAM_INVALID _CHANNEL and return without any action .

If development error detection is enabled for the OCU driver : If the notification function is the NULL pointer , the function Ocu _DisableNotification shall raise the error OCU_ E_ NO_VALID_NOTIF and re t urn without any action .

The function Ocu_ EnableNotification shall en able the OCU compare match notification of the indexed channel.

The function Ocu_EnableNotification shall be reentrant if it is called for different channels.

The function Ocu_ EnableNotification shall be pre compile time configurable On/Off by the configuration parameter: OcuNotificationSupported {OCU_NOTIFICATION_SUPPORTED} .

If development error detection is enabled for the OCU driver : If the driver is not initialized, the function Ocu_ EnableNotification shall raise the error OCU_E_UNINIT and re t urn without any action.

If development error detection is enabled for the OCU driver : If the parameter Channel is invalid (not within the range specified by configuration), then the function Ocu_ EnableNotification shall raise the error OCU_E_PARAM_INVALID _CHANNEL and return without any action .

If development error detection is enabled for the OCU driver : If the notification function is the NULL pointer, the function Ocu_ EnableNotification shall raise the error OCU_E_NO_VALID_NOTIF and return without any action .

The function Ocu _GetVersionInfo shall return the version information of this module. The version information includes: - Module Id - Vendor Id - Vendor specific version numbers .

The function Ocu _GetVersionInfo shall be pre compile time configurable On/Off by the configuration parameter: Ocu VersionInfoApi { OCU _VERSION_INFO_API}.

If source c ode for caller and callee of Ocu _GetVersionInfo is available; the OCU driver shou ld realize Ocu _GetVersionInfo as a macro, defined in the module’s header file .

If development error detection is enabled for the OCU driver , the function Ocu_GetVersionInfo shall raise development error OCU_E_PARAM_POINTER if parameter versioninfo is a null pointer, and return without any action

Det _ Report Error Det.h Service to report development errors.

The OCU driver shall call the function Ocu _Notification _< Channel # > according to the last call of Ocu _EnableNotification /Ocu_DisableNotification for channel < Channel # > , if there’s a compare match on that channel .

The OCU driver shall reset the interrupt flag (if needed by hardware) as sociated with the notification Ocu _Notification_< Channel # >

The O cu notification functions shall be configurable as function pointers within the initialization data structure ( Oc u_ConfigType ).

⌈ If the NULL pointer is configured for a notification call - back, then no call - back shall be executed.

When the notification mechanism is disabled, the OCU driver shall send no notification.

The API Ocu_ DeI nit shall stop all free - running counters, which are exclusively used by this driver.

If development error detection is enabled for the OCU driver: i f a channel is still in the RUNNING state when the function Ocu_DeInit is called, then the function sh all raise the development error ‘ OCU_E_PARAM_INVALID_STATE ’ and return without any action.

The OCU module shall reject configurations with partition mappings which are not s upported by the implementation.

Type of error Related error code Error value API services other than Ocu_ Get Version Info() and Ocu_ init() used without module initialization OCU_ E_ UNINIT 0x02 API service used with an invalid channel Identifier. OCU_ E_ PARAM_ INVALID_ CHANNEL 0x03 API Ocu_ Set Pin State() called with an invalid pin state or when the channel is in the RUNNING state. OCU_ E_ PARAM_ INVALID_ STATE 0x04 API Ocu_ Set Pin Action() called with an invalid pin action. OCU_ E_ PARAM_ INV ALID_ ACTION 0x05 Usage of Ocu_ Disable Notification() or Ocu_ Enable Notification() on a channel where a NULL pointer is configured as the notification function. OCU_ E_ NO_ VALID_ NOTIF 0x06 API Ocu_ Init() called while the OCU driver has already been initialized OCU_ E_ ALREADY_ INITIALIZED 0x07 API Ocu_ Get Version Info() is called with a NULL parameter. OCU_ E_ PARAM_ POINTER 0x08 Ocu_ Set Pin State() or Ocu_ Set Pin Action() called for a channel that doesn't have an associated output pin. OCU_ E_ PARAM_ NO_ PIN 0x0A OCU initialization has been failed, e.g. selected configuration set doesn't exist. OCU_ E_ INIT_ FAILED 0x0B

Type of error Related error code Error value API Ocu_ Start Channel() called on a channel that is in state RUNNING OCU_ E_ BUSY 0x09

The ECUC partitions referenced by OcuKernelEcucPartitionRef shall be a subset of the ECUC partitions referenced by OcuEcucPartitionRef.

The ECUC partitions referenced by OcuChannelEcucPartitionRef shall be a subset of the ECUC partitions referenced by OcuEcucPartitionRef.

If OcuEcucPartitionRef references one or more ECUC partitions, OcuKernelEcucPartitionRef shall have a multiplicity of one and reference one of these ECUC partitions as well

If OcuEcucPartitionRef references one or more ECUC partitions, OcuKernelEcucPartitionRef shall have a multiplicity of one and reference one of these ECUC partitions as well