I/O Hardware Abstraction (IoHwAb)

Initializes either all the IO Hardware Abstraction software or is a part of the IO Hardware Abstraction.

Returns the version information of this module.

Will be called by the ADC Driver when a group conversion is completed for group <#group ID>.

Will be called by the PWM Driver when a signal edge occurs on channel <#channel>.

Will be called by the ICU driver when a signal edge occurs on channel <#channel>.

Will be called by the GPT driver when a timer value expires on channel <#channel>.

This function provides control access to a certain ECU Signal t o the DCM module (<Ecu Signalname> is the symbolic name of an ECU Signal). The ECU signal can be locked and unlocked by this function. Locking 'freezes' the ECU signal to the current value, the configured default value or a value given by the parameter 'si gnal'.

This function provides read access to a certain ECU Signal to the DCM module (<Ecu Signalname> is the symbolic name of an ECU Signal).

The API shall be invoked by the Io Hw Abs in order to prepare the transition to a given power state. The aim of this API is to incapsulate all actions to prepare the HW for a predefined power mode, decoupling application power definition from HW power stat es.

The API shall be invoked by the Io Hw Abs in order to effectively enter a power state which was prepared by the API Io Hw Ab_ Prepare Power State<#Mode> () . The aim of this API is to incapsulate all actions to set the HW in a power state corresponding to a predefined power mode, decoupling application power definition from HW power states.

The API shall be invoked by the ADC Driver when the requested power state preparation for mode <#Mode> is completed.

Will be called by the OCU driver when the current value of the threshold matches the threshold on the channel<#channel>.

The API shall be invoked by the PWM Driver when the requested power state preparation for mode <#Mode> is completed.

Configuration data structure of the Io Hw Ab module.

The I/O Hardware Abstraction shall be based upon the Software Component Template as specified in document [ [8] ].

All ECU Signals shall have a Filtering/Debounce Attribute, so that the captured ‘raw’ - values can be filtered or debounced before passing them to the upper layer. This attribute is only reasonable for input signals. It influences the implementation of acq uisition and access to the signal values.

All ECU signals shall have an Age Attribut e. The Age Attribute has two specific names according to the direction of ECU signal (Input / Output). Anyway, it always contains a maximum time value. Following descriptions explain the meaning of this Attribute for each kind of ECU signals.  ECU Input si gnals: the specific functionality of this attribute is to limit the signals lifetime. The value defines the maximum allowed age for data of this signal. If the lifetime is 0, the signal has to be retrieved from the physical register, immediately. If the li fetime is greater than 0, the signal is valid for the specified time.  ECU Output signals: the specific functionality of this attribute is to limit the signal output to a maximum delay. The value defines the maximum allowed time until this signal is actuall y set. If delay is 0, then the signal has to be set to the physical register, immediately. If the delay is greater than 0, the signal can be set until the configured time has elapsed.

The I/O Hardware Abstraction shall be implemented as one or more instances of the EcuAbstractionSwCo mponentType .

[SWS_IoHwAb_00032] [SWS_IoHwAb_00033]

The implementation has to take into consideration, that the callback functions will be executed in interrupt context.

The number of available cal lback functions and the order of execution will be implementation dependent and must be documented in the I /O Hardware Abstraction BSWMD.

The I/O Hardware Abstraction may contain one or several job processing functions that are BswSchedulableEnt ities (a sub - class of BswModuleEntity by opposition to BswInterruptEntity, e.g. one for each device driver) . They shall be activated according to their use. They will be time - triggered by the BSW Scheduler. They could be synchronized to the execution of th e other runnable entities. The number of BswSchedulableEntities and their order of execution will be imple mentation dependent and must be documented in the I/O Hardware Abstraction description.

The I/O Hardware Abstraction shall define BswModuleEntries to exchange data with other software below the RTE outside interrupt context, for example in case of BSW init ialization/de - initialization.

The initialization/de - initialization functions shall be used/handled by the ECU State Manager, exclusively. For more information, refer to [10] . The number of available functions and the order of execution are implementation - d ependent and must be documented in the I/O Hardware Abstraction description.

Integration code usually means that this software is designed to suite a specific ECU hardware layout. All strategies to protect the hardware shall be included in this software. This document does not intend to standardize or give a recommendation for suc h hardware protection.

The I/O Hardware Abstraction shall not contain strategies for failure recovery. Failure recovery actions can only be decided by the responsible SWC.

[SWS_IoHwAb_00044]

This kind of function initializes eit her all the I/O Hardware Abstraction software, or a part of the I/O Hardware Abstraction.

The multiplicity of I/O devices managed by the I/O Hardware Abstraction software shall be handled via several init functions. Each init function shall be tagged with an <Init_ID>. Therefore, an external device, having its driver encapsulated inside the I/O Hardware Abstraction, can be separately initialized.

This kind of init function shall called by the ECU State Manager. The ECU integrator is able to configure the init sequence order called by the ECU State manager.

An ECU signal represents one electrical signal, which means at least one input or output ECU pin.

The implementation behind the service of the I/O Hardware Abstraction's Provide Ports is ECU specific and the mapping to the corresponding “PortInterface” shall be documented in the Software Component description.

For an ECU Signal associated with a PortInterface configured as an input signal, the I/O Hardware Abstraction shall provide a GET operation, and the operation short name can be freely choose.

The I/O Hardware Abstraction specification defines only recommendations for the Port usage. The in stantiation of the Ports shall be done during the configuration process and is specific to the ECU electronic design.

The I/O Hardware Abstraction implementation shall provide Software Components with access to all MCAL drivers.

The I/O Hardware Abstraction implementation shall provide Software Components with access to communication drivers (for instance by SPI), if on - board devices are managed.

The code file structure shall not be defined within this specification.

After having finished the module initialization, the I/O Hardware Abstraction state sha ll be set to IOHWAB_IDLE , the job result shall be set to IOHWAB_JOB_OK .

The functio n IoHwAb_AdcNotification<#group ID> is intended to be called by the ADC driver when a group conversion is completed for group <#group ID>.

The function IoHwAb_PwmNotifica tion<#channel> is intended to be called by the PWM driver when a signal edge occurs on channel <#channel>.

The function IoHwAb_IcuNotification<#channel> is intended to be called by the ICU driver when a signal edge occurs on channel <#channel>.

The function IoHwAb_GptNotification<#channel> is intended to be called by the GPT driver when a timer value expires on channel <#channel>.

This function allows controlling the associated ECU Signal, i.e. the ECU Signal can be locked, unlocked, and adjusted to a certain value.

This function shall be pre compile time configurable On/Off.

This function provides read access to a certain ECU Signal to the DCM module. The read access is independent from the ECU Signa l's current state (locked/unlocked) and shall always r ead the current physical value from the hardware.

This function shall be pre compile time configurable On/Off.

The function prototype for the callback function functions of the I/O Hardware Abstraction which are routed via RTE shall be implemented according to the following rule: StdReturnType R te_Call_<p>_<o>(<parameters>)

These requirements are not applicable to this specification.

This API is a configurable callout and shall be defined per configuration once per Power Mode to be managed.

This callout shall be executed in the context of the IoHwAbs SWC, meani ng that it has full access to the MCAL.

This API is a configurable callout and sha ll be defined per configuration once per Pow er Mode to be managed.

This callout shall be executed in the context of the IoHwAbs SWC, meaning that it has full access to the MCAL.

This API executes all power st ate transition prepared by the preceding cal l to the correposonding IoHwAb_PreparePowerState<#Mode>.

The function IoHwAb_OcuNotification<#channel> is intended to be called by the OCU driver when the current value of the counter matches the thre shold on channel <#channel>.

The Configuration pointer ConfigPtr shall always have a N ULL_PTR value

Type of error Related error code Error value Up to the implementer to define error he wants to report Up to the implementer 0x01

Adc _ Get Group - Status Adc.h Returns the conversion status of the requested ADC Channel group. Adc _ Get - Stream Last - Pointer Adc.h Returns the number of valid samples per channel, stored in the result buffer. Reads a pointer, pointing to a position in the group result buffer. With the pointer position, the results of all group channels of the last completed conversion round can be accessed. With the pointer and the return value, all valid group conversion results can be accessed (the user has to take the layout of the result buffer into account). Adc _ Read - Group Adc.h Reads the group conversion r esult of the last completed conversion round of the requested group and stores the channel values starting at the Data Buffer Ptr address. The group channel values are stored in ascending channel number order ( in contrast to the storage layout of the resu lt buffer if streaming access is configured). Adc _ Setup - Result Buffer Adc.h Initializes ADC driver with the group specific result buffer start address where the conversion results will be stored. The application has to ensure that the application buffer , where Data Buffer Ptr points to, can hold all the conversion results of the specified group. The initialization with Adc_ Setup Result Buffer is required after reset, before a group conversion can be started. Adc _ Start - Group - Conversion Adc.h Starts th e conversion of all channels of the requested ADC Channel group. Adc _ Stop - Group - Conversion Adc.h Stops the conversion of the requested ADC Channel group. Dio _ Read - Channel Dio.h Returns the value of the specified DIO channel. Dio _ Read - Channel Group Dio.h This Service reads a subset of the adjoining bits of a port. Dio _ Read Port Dio.h Returns the level of all channels of that port. Dio _ Write - Channel Dio.h Service to set a level of a channel. Dio _ Write - Channel Group Dio.h Service to set a sub set of the adjoining bits of a port to a specified level. Dio _ Write Port Dio.h Service to set a value of the port. Gpt _ Check - Wakeup Gpt.h 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. Gpt _ Disable - Wakeup Gpt.h Disables the wakeup interrupt of a channel (rel evant in sleep mode). Gpt _ Enable - Wakeup Gpt.h Enables the wakeup interrupt of a channel (relevant in sleep mode). Gpt _ Get Time - Elapsed Gpt.h Returns the time already elapsed. Gpt _ Get Time - Remaining Gpt.h Returns the time remaining until the target time is reached. Gpt _ Set Mode Gpt.h Sets the operation mode of the GPT. Icu _ Disable - Edge Count Icu.h This function disables the counting of edges of the given channel. Icu _ Disable - Notification Icu.h This function disables the notification of a channel. Icu _ Disable - Wakeup Icu.h This function disables the wakeup capability of a single ICU channel. Icu _ Enable - Edge Count Icu.h This function enables the counting of edges of the given channel. Icu _ Enable - Notification Icu.h This function enables the notification on the given channel. Icu _ Enable - Wakeup Icu.h This function (re - )enables the wakeup capability of the given ICU channel. Icu _ Get Duty - Icu.h This function reads the coherent active time and period time for the Cycle Values given ICU Channel. Icu _ Get Edge - Numbers Icu.h This function reads the number of counted edges. Icu _ Get Input - State Icu.h This function returns the status of the ICU input. Icu _ Ge t Time - Elapsed Icu.h This function reads the elapsed Signal Low Time for the given channel. Icu _ Get - Timestamp - Index Icu.h This function reads the timestamp index of the given channel. Icu _ Reset Edge - Count Icu.h This function resets the value of the c ounted edges to zero. Icu _ Set - Activation - Condition Icu.h This function sets the activation - edge for the given channel. Icu _ Start Signal - Measurement Icu.h This function starts the measurement of signals. Icu _ Start - Timestamp Icu.h This function starts the capturing of timer values on the edges. Icu _ Stop Signal - Measurement Icu.h This function stops the measurement of signals of the given channel. Icu _ Stop - Timestamp Icu.h This function stops the timestamp measurement of the give n channel. Ocu _ Disable - Notification Ocu.h This service is used to disable notifications from an OCU channel. Ocu _ Enable - Notification Ocu.h This service is used to enable notifications from an OCU channel. Ocu _ Get - Counter Ocu.h Service to read the current value of the counter. Ocu _ Set - Absolute - Threshold Ocu.h Service to set the value of the channel threshold using an absolute input data. Ocu _ Set Pin - State Ocu.h Service to set immediately the level of the pin associated to a n OCU channel. Ocu _ Set - Relative - Threshold Ocu.h Service to set the value of the channel threshold relative to the current value of the counter. Ocu _ Start - Channel Ocu.h Service to start an OCU channel. Ocu _ Stop - Channel Ocu.h Service to stop an OCU channel. Port _ Refresh - Port.h Refreshes port direction. Port Direction Port _ Set Pin - Direction Port.h Sets the port pin direction Port _ Set Pin - Mode Port.h Sets the port pin mode. Pwm _ Get - Output State Pwm.h Service to read the internal state of the PWM output signal. Spi _ Async - Transmit Spi.h Service to transmit data on the SPI bus. Spi _ Cancel Spi.h Service cancels the specified on - going sequence transmission. Spi _ Get H W - Unit Status Spi.h This servic e returns the status of the specified SPI Hardware microcontroller peripheral. Spi _ Get Job - Result Spi.h This service returns the last transmission result of the specified Job. Spi _ Get - Sequence - Result Spi.h This service returns the last transmission result of the specified Sequence. Spi _ Get Status Spi.h Service returns the SPI Handler/ Driver software module status. Spi _ Main - Function _ - Handling Sch M_ Spi.h -- Spi _ Read I B Spi.h Service for reading s ynchronously one or more data from an IB SPI Handler/ Driver Channel specified by parameter. Spi _ Set Async - Mode Spi.h Service to set the asynchronous mechanism mode for SPI busses handled asynchronously. Spi _ Setup E B Spi.h Service to setup the buffe rs and the length of data for the EB SPI Handler/ Driver Channel specified. Spi _ Sync - Transmit Spi.h Service to transmit data on the SPI bus Spi _ Write I B Spi.h Service for writing one or more data to an IB SPI Handler/ Driver Channel specified by parameter.

Det _ Report Error Det.h Service to report development errors. Ecu M _ Set Wakeup Event Ecu M.h Sets the wakeup event.

Module Header File Imported Type Adc Adc.h Adc _ Group Type Adc.h Adc _ Status Type Adc.h Adc _ Stream Num Sample Type Adc.h Adc _ Value Group Type Dio Dio.h Dio _ Channel Group Type Dio.h Dio _ Channel Type Dio.h Dio _ Level Type Dio.h Dio _ Port Level Type Dio.h Dio _ Port Type Ecu M Ecu M.h Ecu M _ Wakeup Source Type Gpt Gpt.h Gpt _ Channel Type Gpt.h Gpt _ Mode Type Gpt.h Gpt _ Value Type Icu Icu.h Icu _ Activation Type Icu.h Icu _ Channel Type Icu.h Icu _ Duty Cycle Type Icu.h Icu _ Edge Number Type Icu.h Icu _ Index Type Icu.h Icu _ Input State Type Icu.h Icu _ Value Type Ocu Ocu.h Ocu _ Channel Type Ocu.h Ocu _ Pin State Type Ocu.h Ocu _ Return Type Ocu.h Ocu _ Value Type Port Port.h Port _ Pin Direction Type Port.h Port _ Pin Mode Type Port.h Port _ Pin Type Pwm Pwm.h Pwm _ Channel Type Pwm.h Pwm _ Output State Type Spi Spi.h Spi _ Async Mode Type Spi.h Spi _ Channel Type Spi.h Spi _ Data Buffer Type Spi.h Spi _ H W Unit Type Spi.h Spi _ Job Result Type Spi.h Spi _ Job Type Spi.h Spi _ Number Of Data Type Spi.h Spi _ Seq Result Type Spi.h Spi _ Sequence Type Spi.h Spi _ Status Type Std Std_ Types.h Std _ Return Type Std_ Types.h Std _ Version Info Type