OSGetDefaultThread

Syntax

#include <cafe/os.h>

OSThread* OSGetDefaultThread(u32 coreId);

Parameters

coreId The number of the CPU Core for which the default thread is being requested (0 ≤ coreId < MAX_SYSTEM_CORES).

Return Values

Pointer to the default thread for the selected processor Core.

Description

The default threads are per-core threads that are created when a process starts. The default threads must exist because the OS uses these threads to start the application. The default threads must exist through the lifetime of the process. OSGetDefaultThread gets the pointer to the default thread used to start the specified processor core.

On the main core, Core 1, the default thread runs the main entry point main(argc,argv). On the other cores (Core 0 and Core 2), the default thread is idle and can be configured to run a specific function by using OSRunThread, as shown in the demo located at:

$CAFE_ROOT/system/src/demo/helloworld

Do Not Call From

None.

See Also

OSRunThread

Revision History

2014/02/27 Added info on default threads.
2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup pass.
2010/11/08 Initial version.


CONFIDENTIAL