Baseport Template Client Interface Guide

The Baseport Template platform service provide an interface to +the kernel-side client for hardware-specific functions (for example, +GPIO, DMA, IIC, USB Client Controller) that are used by the kernel.

+ Interface class

The client interface +for the Baseport Template platform service is: + + + +API +Description + + + + +
TemplateAssp
+
Provides common peripheral control functions such as power, +bootstrap, keymap, keyboard and sound that other extensions and device +drivers can use
+ + + +

The Baseport Template interface provides the following +functions.

+ + + +Function +Return Type +Description + + + + +

TemplateAssp::Init1()

+void +

Initialize the ASSP interrupt controller

+ + +

TemplateAssp::Init3()

+void +

Called in the context of the supervisor thread

+ + +

TemplateAssp::StartupReason()

+TMachineStartupType +

Return the Startup reason of the Super Page (set up by Bootstrap)

+ + +

TemplateAssp::MsTickPeriod()

+TInt +

Obtain the period of System Tick timer in microseconds

+ + +

TemplateAssp::SystemTimeInSecondsFrom2000(TInt& +aTime);

+TInt +

Obtain System Time from the RTC

+ + +

TemplateAssp::SetSystemTimeInSecondsFrom2000(TInt +aTime)

+TInt +

Obtain Adjust the RTC with new System Time

+ + +

TemplateAssp::NanoWaitCalibration()

+TUint32 +

Obtain the time it takes to execute two processor instructions

+ + + +

Pure +Virtual Functions for derivation by variant

These are the +functions whose implementation are not provided in the class, but +the behavior can be overridden within an inheriting class by a function +with the same return type.

External interrupt handling functions are used by second-level interrupt controllers at variant level.

+ + + +Functions +Return Type + + + + +

TemplateAssp::InterruptBind(TInt anId, TIsr anIsr, +TAny* aPtr)

+TInt + + +

TemplateAssp::InterruptUnbind(TInt anId)

+TInt + + +

TemplateAssp::InterruptEnable(TInt anId)

+TInt + + +

TemplateAssp::InterruptDisable(TInt anId)

+TInt + + +

TemplateAssp::InterruptClear(TInt anId)

+TInt + + + +

USB client controller functions are the called by +the USB PSL, and to be implemented by the variant .

+ + + +Functions +Return Type + + + + +

TemplateAssp::UsbClientConnectorDetectable()

+TBool + + +

TemplateAssp::UsbClientConnectorInserted()

+TBool + + +

TemplateAssp::RegisterUsbClientConnectorCallback(TInt +(*aCallback)(TAny*), TAny* aPtr)

+TInt + + +

TemplateAssp::UnregisterUsbClientConnectorCallback()

+void + + +

TemplateAssp::UsbSoftwareConnectable()

+TBool + + +

TemplateAssp::UsbConnect()

+TInt + + +

TemplateAssp::UsbDisconnect()

+TInt + + + +