37.3.4.2 Clear Flags

Purpose

This service can be used to clear parameter structure flags.

How to Use the Service

Description

This service clears CarryOut, CarryIn, Zero and Violation flags in the Specific bit field. The Gf2n flag is untouched.

The service name for this operation is ClearFlags.

Parameters Definition

It is possible to directly address this service through the PUKCL_ClearFlags() macro.

Table 37-7. Clear Flags Service Parameters
Parameter	Type	Direction	Location	Data Length	Before Executing the Service	After Executing the Service
Specific/CarryOut	Bit	O	–	–	–	Cleared
Specific/CarryIn	Bit	O	–	–	–	Cleared
Specific/Zero	Bit	O	–	–	–	Cleared
Specific/Violation	Bit	O	–	–	–	Cleared

Code Example

PUKCL_PARAM PUKCLParam;
PPUKCL_PARAM pvPUKCLParam = &PUKCLParam;

// vPUKCL_Process() is a macro command, which populates the service name
// and then calls the library...
vPUKCL_Process(ClearFlags,pvPUKCLParam); 
if (PUKCL(u2Status) == PUKCL_OK)
            {
            // Success   
            }
else // Manage the error

Status Returned Values

Table 37-8. ClearFlags Service Return Codes
Returned Status	Importance	Meaning
PUKCL_OK	–	Service functioned correctly.