Mitsubishi Electric MELSEC iQ-R Series Manual page 60

CITL_SysClkRateSet
This function saves the specified system clock rate in the flash ROM.
■ Format
short CITL_SysClkRateSet(short sTicks, short* psRestart)
■ Argument
Argument
sTicks
psRestart
■ Description
• This function saves the system clock rate specified to the clock rate (sTicks) in the flash ROM.
The specified system clock rate will be enabled after restarting a C intelligent function module.
• When the output to the restart necessity flag (psRestart) is "0" (restart is not required), continue the application processing.
• When the output to the restart necessity flag (psRestart) is "1" (restart is required), restart the C intelligent function module
by stopping the application processing and resetting the CPU module or turning the power OFF and ON.
• For more details on system clock rate, refer to the manual for VxWorks.
Precautions
• Execute this function only once after a C intelligent function module is started.
If this function is executed by specifying the same clock rate value as the first time, the restart necessity flag (psRestart) will
be '0' (restart is not required) regardless of the system clock rate value in operation.
• Use this function to change the system clock rate.
If the sysClkRateSet function of VxWorks is used, the operation of VxWorks will be unstable.
■ Return value
Return value
0 (0000H)
Other than 0 (0000H)
■ Relevant function
Page 57 CITL_SysClkRateGet
3 DETAILS OF FUNCTION
58
3.1 C Intelligent Function Module Dedicated Functions
Name
Clock rate
Restart necessity flag
Description
Normal
Error
For details on the error, refer to the following chapter.
Page 108 ERROR CODE LIST
Description
Specify the system clock rate in the unit of clock frequency (Hz) per one second.
• 0: Default value (60 Hz)
• 60 to 1000: Specified clock rate value
Stores the necessity to restart a C intelligent function module after the execution of
this function.
(When 'NULL' is specified, the restart necessity flag is not stored.)
• 0: Restart is not required. (The C intelligent function module has already been
running at the specified clock rate.)
• 1: Restart is required. (The C intelligent function module operates at the specified
clock rate after restarting it.)
IN/OUT
IN
OUT