macro

slSoundOn

Format

    #include "sgl.h"

    Bool slSoundOn( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Turn on the sound.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, a result code of NG will be returned and the command will not be issued.If the command is successfully registered, Returns OK .

Note

Using this macro will launch a sound block.
When stopping and starting SoundBlock, please be sure to strictly adhere to the following restrictions:
・Restrictions regarding stopping and starting the sound block When the sound block is stopped, there must not be a non-access period of 0.5 seconds or more from the main system (SH2 side) to the sound RAM. If you want to stop the sound block, load the sound driver, etc. Please stop it only for the minimum period necessary and restart it immediately.
If you do not need to use the sound CPU (MC68EC000), you will need to take measures such as running a dummy program.
Executing this macro will reset the sound chip (SCSP). After SCSP is reset, access is prohibited for 30 μs as SCSP initializes its internal registers. Since the macro does not perform any wait processing, please control the application side so that it does not access SCSP during this period.

reference

 slSoundOff

 slSoundOnWait

 slSoundOffWait

List ｜ Reference

macro

slSoundOff

Format

    #include "sgl.h"

    Bool slSoundOff( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Turn off the sound.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, a result code of NG will be returned and the command will not be issued.If the command is successfully registered, Returns OK .

Note

Using this macro will stop sound blocking.
When stopping and starting SoundBlock, please be sure to strictly adhere to the following restrictions:
・Restrictions regarding stopping and starting the sound block When the sound block is stopped, there must not be a non-access period of 0.5 seconds or more from the main system (SH2 side) to the sound RAM. If you want to stop the sound block, load the sound driver, etc. Please stop it only for the minimum period necessary and restart it immediately.
If you do not need to use the sound CPU (MC68EC000), you will need to take measures such as running a dummy program.

reference

 slSoundOn

 slSoundOnWait

 slSoundOffWait

List ｜ Reference

macro

slNMIRequest

NMI request

Format

    #include "sgl.h"

    Bool slNMIRequest( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Requests NMI from master SH2.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, a result code of NG will be returned and the command will not be issued.If the command registration is successful, Returns OK .

Note

Use this function only when you want to perform a reset operation when the reset button is disabled. (When using modem, etc.) Do not use it in other applications.

reference

 slNMIRequestWait

List ｜ Reference

macro

slResetEnable

reset enable

Format

    #include "sgl.h"

    Bool slResetEnable( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Enables reset.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, a result code of NG will be returned and the command will not be issued.If the command registration is successful, Returns OK .

reference

 slResetDisable

 slResetEnableWait

 slResetDisableWait

List ｜ Reference

macro

slResetDisable

reset disable

Format

    #include "sgl.h"

    Bool slResetDisable( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Disable reset.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, a result code of NG will be returned and the command will not be issued.If the command registration is successful, Returns OK .

Note

This command cannot be issued from a slave CPU. If you issue this command from the slave CPU, the result code will return NG and you will not be able to issue it.
Always disable the reset button when accessing backup memory.
Please re-enable it as soon as you finish accessing the backup memory.
However, if the modem is in use, please disable the permanent reset button.

reference

 slResetEnable

 slResetEnableWait

 slResetDisableWait

List ｜ Reference

macro

slSetSmpcMemory

SMPC memory settings

Format

    #include "sgl.h"

    Bool slSetSmpcMemory( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Requests settings for SMPC memory.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, a result code of NG will be returned and the command will not be issued.If the command registration is successful, Returns OK .

reference

slSetSmpcMemoryWait	slSetLanguage	slSetSoundEffect	slSetSoundOutput
slSetHelpWindow

List ｜ Reference

macro

slSetDateTime

Time setting

Format

    #include "sgl.h"

    Bool slSetDateTime( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Set the SMPC real-time clock.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, a result code of NG will be returned and the command will not be issued.If the command registration is successful, Returns OK .

Note

When using this function, please be careful to comply with the creation standards.

reference

 slSetDateTimeWait

★Command end return type

List ｜ Reference

macro

slSoundOnWait

Format

    #include "sgl.h"

    Bool slSoundOnWait( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Turn on the sound and wait for the command to finish executing.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, or if an interrupt back has been issued, a result code of NG will be returned and the command will not be issued.
Returns OK if the command registration was successful.

Note

Using this macro will launch a sound block.
When stopping and starting SoundBlock, please be sure to strictly adhere to the following restrictions:
・Restrictions regarding stopping and starting the sound block When the sound block is stopped, there must not be a non-access period of 0.5 seconds or more from the main system (SH2 side) to the sound RAM. If you want to stop the sound block, load the sound driver, etc. Please stop it only for the minimum period necessary and restart it immediately.
If you do not need to use the sound CPU (MC68EC000), you will need to take measures such as running a dummy program.
Executing this macro will reset the sound chip (SCSP). After SCSP is reset, access is prohibited for 30 μs as SCSP initializes its internal registers. The macro does not perform any wait processing, so please control the application side so that it does not access SCSP during this period.

reference

 slSoundOffWait

 slSoundOn

 slSoundOff

List ｜ Reference

macro

slSoundOffWait

Format

    #include "sgl.h"

    Bool slSoundOffWait( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Turn off the sound and wait for the command to finish executing.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, or if an interrupt back has been issued, a result code of NG will be returned and the command will not be issued.
Returns OK if the command registration was successful.

Note

reference

 slSoundOnWait

 slSoundOn

 slSoundOff

List ｜ Reference

macro

slNMIRequestWait

NMI request

Format

    #include "sgl.h"

    Bool slNMIRequestWait( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Requests NMI from master SH2 and waits for command execution to finish.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, or if an interrupt back has been issued, the result code NG will be returned and the command will not be issued.
Returns OK if the command registration was successful.

Note

Use this function only when you want to perform a reset operation when the reset button is disabled. (When using modem, etc.) Do not use it in other applications.

reference

 slNMIRequest

List ｜ Reference

macro

slResetEnableWait

reset enable

Format

    #include "sgl.h"

    Bool slResetEnableWait( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Enable reset and wait for command execution to finish.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, or if an interrupt back has been issued, a result code of NG will be returned and the command will not be issued.
Returns OK if the command registration was successful.

reference

 slResetEnableWait

 slResetEnable

 slResetDisable

List ｜ Reference

macro

slResetDisableWait

reset disable

Format

    #include "sgl.h"

    Bool slResetDisableWait( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Disables reset and waits for the command to finish executing.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, or if an interrupt back has been issued, a result code of NG will be returned and the command will not be issued.
Returns OK if the command registration was successful.

Note

reference

 slResetDisableWait

 slResetEnable

 slResetDisable

List ｜ Reference

macro

slSetSmpcMemoryWait

SMPC memory settings

Format

    #include "sgl.h"

    Bool slSetSmpcMemoryWait( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Requests SMPC memory settings and waits for command execution to finish.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, or if an interrupt back has been issued, the result code NG will be returned and the command will not be issued.
Returns OK if the command registration was successful.

reference

slSetSmpcMemory	slSetLanguage	slSetSoundEffect	slSetSoundOutput
slSetHelpWindow

List ｜ Reference

macro

slSetDateTimeWait

Time setting

Format

    #include "sgl.h"

    Bool slSetDateTimeWait( void );

argument

    void - gives nothing.

Return number

    Bool - Flag indicating whether the process ended normally (described later).

function

Requests SMPC real-time clock settings and waits for command execution to finish.
If the semaphore cannot be acquired because another process is locking it, or if the command cache for SMPC has overflowed, or if an interrupt back has been issued, a result code of NG will be returned and the command will not be issued.
Returns OK if the command registration was successful.

Note

When using this function, please be careful to comply with the creation standards.

reference

 slSetDateTime

return