This is the multi-page printable view of this section. Click here to print.
Xcp
1 - ApXcp_Integration_Manual
1.2 Functions to be provided to Integration Project 2
2.2 Configuration Files to be provided by Integration Project 3
2.2.1 Da Vinci Config generation 3
2.2.2 Manual Configuration Changes 3
3.1 Required Global Data Inputs 4
3.2 Optional Global Data Inputs 4
3.3 Specific Include Path present 4
Dependencies
GetSetIndexes() and GetPersIndexes()
Overview
The integration specific functions below, GetSetIndexes and GetPersIndexes, are used to return an array of tuning identifiers to the tune-on-the-fly (or online calibration as defined in the XCP specs) function. They are used to copy the active sets or personalities into RAM. The functions should be implemented in an integration specific component that determines the desired personality and desired set identifiers sent to tuning select authority SWC.
If tune-on-the-fly functionality is disabled, the functions below do not need to be defined.
If tune-on-the-fly is enabled and the lookup functions are disabled, the functions below do not need to be defined. When a copy cal page XCP command is called, the personalities are copied from 0 to a max limit based on the active tuning set that is currently being used. In the case of the tuning sets being copied, only the active tuning set is copied in to the RAM.
| Module | Required API |
|---|---|
| <Integration Specific Module> | Function outline defined below: |
Function Prototypes
The actual implementation of the function will vary between programs. However, the function should be structured so the passed arguments are of the same time to provide a common interface to the XCP functions.
| Function Name | GetSetIndexes or GetPersndexes | Type | Dir. | Min | Max | UTP Tol. |
| Arguments Passed | NumOfSets_Cnt_T_u8 or NumOfPers_Cnt_T_u8 | uint8 | I | 0 | 255 | |
| data | uint8* | I/O | 0 | 255 | ||
| Return Value | N/A |
Example 1 -- BMW
The following example illustrates a similar situation found in the BMW program. Active personalities are determined by coding bits. Using the GetPersIndexes function, the function will loop through the personalities to find the index of the personality that contains the matching coding ID. The indexes are returned and the active personalities are copied into RAM.
ProcessXCPPID()
Overview
This function must be available to this module to call by the integration manual. This should be provided by the CMS component which does the processing on XCP PIDs. This function is required to allow the CMS component to figure out when an XCP PID is finished being read or written.
| Module | Required API |
|---|---|
| CMS Common | Function outline defined below: |
Function Prototypes
| Function Name | ProcessXCPPID | Type | Dir. | Min | Max | UTP Tol. |
| Arguments Passed | Size_Cnt_T_u08 | uint8 | I | 1 | 8 | |
| Return Value | N/A |
Configuration
Build Time Config
| Modules | Notes | |
|---|---|---|
| None |
Configuration Files to be provided by Integration Project
Da Vinci Parameter Configuration Changes
| Parameter | Notes | SWC |
|---|---|---|
| D_NUMOFVLDEEMEMRGNS_CNT_U08 | Generated in Ap_ApXcp.Cfg.h if external EEPROM access is set to STD_ON in Configurator. Value will be determined by the EEPROM memory access defined in the ECUC file. | ApXcp |
| BC_XCP_EXTEEPACCESS | Set to STD_ON in Configurator if XCP access to external EEPROM is required. | ApXcp |
| BC_XCP_TUNEONFLY | Set to STD_ON in Configuartor if tune-on-the-fly support is required. | ApXcp |
| BC_XCP_PERSINDEXLOOKUP | Set to STD_ON in Configurator if a function call to GetPersIndexes is required to return the indexes of active personalities. Note: BC_XCP_TUNEONFLY must be set to STD_ON | ApXcp |
| BC_XCP_SETINDEXLOOKUP | Set to STD_ON in Configurator if a function call to GetSetIndexes is required to return the indexes of active sets. Note: BC_XCP_TUNEONFLY must be set to STD_ON | ApXcp |
| <Non Trusted Function Stack Size> | This needs to be configured (to a non-zero value) for the task or ISR that handles the XCP commands. This is required to support application switching for XCP writes. Please note this is only required if a program has non-trusted applications configured. | Os |
| <Trusted/Non Trusted functions for XCP writes> | If a program has multiple applications configured, non-trusted or trusted functions must be configured for each application. This is required to allow the XCP write commands to switch context before performing the write. These functions should end up calling ApXcpWriteCommon() to perform the write. Ex: NtWrapS_XcpWriteAp8() NtWrapS_XcpWriteAp9() TWrapS_XcpWriteAp0 | Os |
| BC_XCP_TOTFRAMSIZE_UNT_32 | This should be set to the same size as the amount of RAM allocated to TOTF. Also used as the size of the buffer if Segment16 is enabled. | ApXcp |
| BC_XCP_SEG[x]ENABLE | This should be set to STD_ON to enable the number segment, where [x] = Segment number. | ApXcp |
| BC_XCP_MAXPERCOPY_CNT_U8 | Used with segment 0, the number represents the number of tuning personalities to copy into RAM. Must be set to at least 1. | ApXcp |
| CalConstNumOfPerSymbol | Set to the number of tuning personalties constant. Typically this is defined in CalConstants.h with the name D_NUMOFPERS_CNT_U16. | ApXcp |
| BC_XCP_MAXSETCOPY_CNT_U8 | Used with segment 1, the number represents the number of tuning sets to copy into RAM. Must be set to at least 1. | ApXcp |
| CalConstNumOfSetSymbol | Set to the number of tuning sets constant. Typically this is defined in CalConstants.h with the name D_NUMOFTUNSETS_CNT_U16. | ApAcp |
| BC_XCP_SEG16LNKSYMB | Used with segment 16. The linker symbol represents the start address of the custom memory range to copy into RAM. | ApXcp |
| BC_XCP_SEG16LNKSYMBLEN_CNT_U8 | Used with segment 16. The linker symbol represents the size of the custom memory range to copy into RAM. | ApXcp |
DaVinci Interrupt Configuration Changes
| ISR Name | VIM # | Priority Dependency | Notes |
|---|---|---|---|
Manual Configuration Changes
| Constant | Notes | SWC |
|---|---|---|
GENy Configuration Changes
| Parameter | Notes | SWC |
|---|---|---|
| User configuration file | ApXcp component functionality relies on a callout function for XCP memory writing from the XCP module as delivered by vector. To enable this callout function, a user configuration file typically needs to be included in the GENy configuration to enable the appropriate build constant. See attached file below | GENy XCP configuration |
| General Settings->Enable Calibration | This should be enabled to allow download commands | GENy XCP configuration |
| General Settings->Memory Write Protection | This should be enabled to allow checking of XCP access on the addresses requested for writing. | GENy XCP configuration |
| General Settings->Memory Read Protection | This should be enabled to allow checking of XCP access on the addresses requested for reading. | GENy XCP configuration |
| EEPROM Access->Read Access | This needs to be enabled if external EEPROM is available and needs to be read through XCP | GENy XCP configuration |
| EEPROM Access->Write Access | This needs to be enabled if external EEPROM is available and needs to be written through XCP | GENy XCP configuration |
| Standard Commands->User Defined Command | This needs to be enabled for CMS XCP support | GENy XCP configuration |
| Block Transfer->Block Upload | Needs to be enabled to support large XCP PID reads | GENy XCP configuration |
| Block Transfer->Block Download | Needs to be enabled to support large XCP PID writes | GENy XCP configuration |
| Page Switching->Page Switching | Needs to be enabled only if Tune On the Fly Support is turned on | GENy XCP configuration |
| Page Switching->General Paging Info | Needs to be enabled only if Tune On the Fly Support is turned on | GENy XCP configuration |
| Page Switching->Copy Page | Needs to be enabled only if Tune On the Fly Support is turned on | GENy XCP configuration |
Integration
Required Global Data Inputs
<Mention any global variable that this component requires for other components>
Required Global Data Outputs
<Mention any global variable that this component requires for other components>
Specific Include Path present
Yes
Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger |
|---|---|---|
| ApXcp_Init | Should be called prior to the start of the O/S (typically EcuStartup_Init1) | Once At Init |
| Runnable | Scheduling Requirements | Trigger |
|---|---|---|
| ApXcp_Per1 | None | RTE (10ms) |
| DAQ_2msTL | RTE (2ms) | |
| DAQ_1msTL | This function should only be scheduled if 1ms DAQ support is required. If not, it needs to be deleted from the integration project in the ApXcp Component. | RTE (1ms) |
.
Memory Mapping
Mapping
| Memory Section | Contents | Notes |
|---|---|---|
| < Memory mapping Info> | ||
* Each …START_SEC… constant is terminated by a …STOP_SEC… constant as specified in the AUTOSAR Memory Mapping requirements.
Usage
| Feature | RAM | ROM |
|---|---|---|
| <Memmap usuage info> |
Non RTE NvM Blocks
| Block Name |
|---|
| <NVM block used Non RTE functions > |
Note : Size of the NVM block if configured in developer
RTE NvM Blocks
| Block Name |
|---|
| <NVM block used in RTE functions > |
Note : Size of the NVM block if configured in developer
Compiler Settings
Preprocessor MACRO
<Define all the preprocessor Macros needed and conditions when needed>.
Optimization Settings
<Define Optimization levels that are needed and conditions when needed>.
Revision Control Log
| Rev # | Change Description | Date | Author |
| 1 | Initial version | 30-July-13 | KJS |
| 2 | Updates for better description of configuration requirements | 29-Aug-13 | LWW |
| 3 | Added updates for new configuration constants generated with tune on the fly. | 10-Oct-13 | KJS |