port.h File Reference

#include <stdbool.h>
#include <stdint.h>

Include dependency graph for port.h:

Go to the source code of this file.

Macros
#define	NACKED   __attribute__((naked))
#define	SYSCALL(num)
#define	SAVE_SYSCALL_RETVAL(ptr)   asm volatile("mov %0, r0" : "=r"(*ptr));

Functions
void	system_ticks_update (void)
uint32_t	get_proc_mode (void)
	Get the current ARM processor mode. More...
void	os_env_init (void *stack)
	Initialze the operating system to split kernel space and user space. More...
void *	jump_to_thread (void *stack, bool privileged)
	Jump to the thread with given stack. More...
void	jump_to_kernel (void)
	Jump to the kernel space. More...
void	__platform_init (void)
	Basic platform initialization. More...
void	__board_init (void)
	Initialize board drivers. More...
void	__stack_init (uint32_t **stack_top, uint32_t func, uint32_t return_handler, uint32_t args[4])
	Initialize thread stack. More...
unsigned long	get_syscall_num (void *sp)
	Get syscall number. More...
void	get_syscall_args (void *sp, unsigned long *pargs[4])
	Get syscall arguments. More...
void	halt (void)
	Halt the system by trapping into an infinity loop. More...
void	__idle (void)
	Trigger platform-specific idling. More...

Macro Definition Documentation

SYSCALL

#define SYSCALL

(

num

)

Value:

    asm volatile(        \
        "push {r7}   \n" \
        "mov  r7, %0 \n" \
        "svc  0      \n" \
        "pop  {r7}   \n" \
        "bx lr       \n" ::"i"(num))

Function Documentation

__board_init()

void __board_init

(

void

)

Initialize board drivers.

Parameters

None

Return values

None

__idle()

void __idle

(

void

)

Trigger platform-specific idling.

Parameters

None

Return values

None

__platform_init()

void __platform_init

(

void

)

Basic platform initialization.

Parameters

None

Return values

None

__stack_init()

void __stack_init	(	uint32_t **	stack_top,
		uint32_t	func,
		uint32_t	return_handler,
		uint32_t	args[4]
	)

Initialize thread stack.

Parameters

stack_top	The pointer to the stack pointer.
func	The function to execute after context switch.
return_handler	The return handler function after fuc returned.
args[4]	The arguments for func.

Return values

None

get_proc_mode()

uint32_t get_proc_mode

(

void

)

Get the current ARM processor mode.

Return values

uint32_t

The ISR_NUMBER field of the IPSR register.

get_syscall_args()

void get_syscall_args	(	void *	sp,
		unsigned long *	pargs[4]
	)

Get syscall arguments.

Parameters

sp	The stack pointer points to the top of the thread stack.
pargs	The array for returning syscall arguments.

Return values

unsigned

long: The current syscall number.

get_syscall_num()

unsigned long get_syscall_num

(

void *

sp

)

Get syscall number.

Parameters

sp	The stack pointer points to the top of the thread stack.

Return values

unsigned

long: The current syscall number.

halt()

void halt

(

void

)

Halt the system by trapping into an infinity loop.

Parameters

None

Return values

None

jump_to_kernel()

void jump_to_kernel

(

void

)

Jump to the kernel space.

Parameters

None

Return values

None

jump_to_thread()

void* jump_to_thread	(	void *	stack,
		bool	privileged
	)

Jump to the thread with given stack.

Parameters

stack	The thread stack for jumping.
privileged	The thread privilege; true for kernel thread and false for user thread.

Return values

uint32_t*

New stack pointer after returning to the kernel.

os_env_init()

void os_env_init

(

void *

stack

)

Initialze the operating system to split kernel space and user space.

Parameters

A	dummy stack memory space to provide.