24.05.2014 Views

Embedded Application Programming Interface - picmg

Embedded Application Programming Interface - picmg

Embedded Application Programming Interface - picmg

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

8.2.1 Description<br />

Start the watchdog timer and set the parameters. To adjust the parameters, the watchdog must be<br />

stopped via EApiWDogStop and then EApiWDogStart must be called again with the new values.<br />

If the hardware implementation of the watchdog timer does not allow to set exactly the selected timing,<br />

the EAPI shall select the next possible longer timing.<br />

8.2.2 Parameters<br />

uint32_t<br />

EAPI_CALLTYPE<br />

EApiWDogStart(<br />

__IN uint32_t delay , /* Delay in msec */<br />

__IN uint32_t EventTimeout /* Timeout in msec */<br />

__IN uint32_t ResetTimeout /* Reset in msec */<br />

);<br />

FUNC_DEF 18: EApiWDogStart<br />

delay<br />

__IN Initial delay for the watchdog timer in milliseconds.<br />

The first trigger must happen within (delay + EventTimeout) milliseconds, of calling EApiWDogStart.<br />

EventTimeout<br />

__IN Watchdog timeout interval in milliseconds to trigger an event.<br />

ResetTimeout<br />

__IN Watchdog timeout interval in milliseconds to trigger a reset.<br />

8.2.3 Return Status Codes<br />

Condition<br />

Library Uninitialized<br />

Unsupported<br />

Delay>pMaxDelay<br />

EventTimeout>pMaxEventTimeout<br />

ResetTimeout>pMaxResetTimeout<br />

Watchdog already started<br />

Return Value<br />

EAPI_STATUS_NOT_INITIALIZED<br />

EAPI_STATUS_UNSUPPORTED<br />

EAPI_STATUS_INVALID_PARAMETER<br />

EAPI_STATUS_INVALID_PARAMETER<br />

EAPI_STATUS_INVALID_PARAMETER<br />

EAPI_STATUS_RUNNING<br />

... see 2.3 Status Codes on page 16<br />

Success<br />

EAPI_STATUS_SUCCESS<br />

8.3 EApiWDogTrigger<br />

uint32_t<br />

EAPI_CALLTYPE<br />

EApiWDogTrigger(void);<br />

FUNC_DEF 19: EApiWDogTrigger<br />

8.3.1 Description<br />

Trigger the watchdog timer.<br />

PICMG® EAPI R1.0, August 8, 2010 page 45 of 83

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!