ECU Measurement and Calibration Toolkit C API Reference

Content Type
Programming Language
Current manual

mcXCPGetCalPage

mcXCPGetCalPage

Purpose

Queries a calibration page setting.

Format

mcTypeStatus mcXCPGetCalPage(
mcTypeTaskRef ECURefNum,
u8 Mode,
u8 Segment,
u8 *Page);

Input

ECURefNum

ECURefNum is the task reference which links to the selected ECU. This reference is originally returned from mcECUSelectEx.

Mode

Mode specifies the access mode:

Mode = 1

The given page is used by the slave device application.

Mode = 2

The slave device XCP driver will access the given page.

Segment

Segment specifies the selected logical data segment number.

Output

*Page

Page returns the logical data page number.

Return Value

The return value indicates the status of the function call as a signed 32-bit integer. Zero means the function executed successfully. A negative value specifies an error, which means the function did not perform the expected behavior. A positive value specifies a warning, which means the function performed as expected, but a condition arose that may require attention.

Use the mcStatusToString function of the ECU M&C API to obtain a descriptive string for the return value.

Description

mcXCPGetCalPage implements the XCP command GET_CAL_PAGE and queries the logical number for the calibration data page that is currently activated for the specified access mode and data segment.

Refer to the ASAM XCP Part 2 Protocol Layer Specification for more information on how to set up a request.

Was this information helpful?