platform.c File Reference

Go to the source code of this file.

Macros
#define	BF_TAG   'BFLK'
#define	BF_NX_TAG   'BFNX'

Functions
void *	platform_alloc_rw (uint64_t len)
void *	platform_alloc_rwe (uint64_t len)
void *	platform_virt_to_phys (void *virt)
void	platform_free_rw (void *addr, uint64_t len)
void	platform_free_rwe (void *addr, uint64_t len)
void	platform_memset (void *ptr, char value, uint64_t num)
void	platform_memcpy (void *dst, const void *src, uint64_t num)
void	platform_start ()
void	platform_stop ()
int64_t	platform_num_cpus ()
int64_t	platform_set_affinity (int64_t affinity)
void	platform_restore_affinity (int64_t affinity)

Macro Definition Documentation

BF_TAG

#define BF_TAG   'BFLK'

Definition at line 28 of file platform.c.

BF_NX_TAG

#define BF_NX_TAG   'BFNX'

Definition at line 29 of file platform.c.

Function Documentation

platform_alloc_rw()

void* platform_alloc_rw

(

uint64_t

len

)

Allocate Memory

Used by the common code to allocate virtual memory.

Parameters

len	the size of virtual memory to be allocated in bytes.

Returns

a virtual address pointing to the newly allocated memory

Definition at line 32 of file platform.c.

platform_alloc_rwe()

void* platform_alloc_rwe

(

uint64_t

len

)

Allocate Executable Memory

Used by the common code to allocate executable virtual memory.

Parameters

len	the size of virtual memory to be allocated in bytes.

Returns

a virtual address pointing to the newly allocated memory

Definition at line 51 of file platform.c.

platform_virt_to_phys()

void* platform_virt_to_phys

(

void *

virt

)

Convert Virtual Address to Physical Address

Given a virtual address, this function returns the associated physical address. Note that any page pool issues should be handle by the platform (i.e. the users of this function should be able to provide any virtual address, regardless of where the address originated from).

Parameters

virt	the virtual address to convert

Returns

the physical address assocaited with the provided virtual address

Definition at line 70 of file platform.c.

platform_free_rw()

void platform_free_rw	(	void *	addr,
		uint64_t	len
	)

Free Memory

Used by the common code to free virtual memory that was allocated using the platform_alloc function.

Parameters

addr	the virtual address returned from platform_alloc
len	the size of the memory allocated

Definition at line 78 of file platform.c.

platform_free_rwe()

void platform_free_rwe	(	void *	addr,
		uint64_t	len
	)

Free Executable Memory

Used by the common code to free virtual memory that was allocated using the platform_alloc_exec function.

Parameters

addr	the virtual address returned from platform_alloc_exec
len	the size of the memory allocated

Definition at line 92 of file platform.c.

platform_memset()

void platform_memset	(	void *	ptr,
		char	value,
		uint64_t	num
	)

Memset

Parameters

ptr	a pointer to the memory to set
value	the value to set each byte to
num	the number of bytes to set

Definition at line 106 of file platform.c.

platform_memcpy()

void platform_memcpy	(	void *	dst,
		const void *	src,
		uint64_t	num
	)

Memcpy

Parameters

dst	a pointer to the memory to copy to
src	a pointer to the memory to copy from
num	the number of bytes to copy

Definition at line 115 of file platform.c.

platform_start()

void platform_start

(

void

)

Start

Run after the start function has been executed.

Definition at line 124 of file platform.c.

platform_stop()

void platform_stop

(

void

)

Stop

Run after the stop function has been executed.

Definition at line 130 of file platform.c.

platform_num_cpus()

int64_t platform_num_cpus

(

void

)

Get Number of CPUs

Returns

returns the total number of CPUs available to the driver.

Definition at line 136 of file platform.c.

platform_set_affinity()

int64_t platform_set_affinity

(

int64_t

affinity

)

Set CPU affinity

Changes the current core that the driver is running on.

Parameters

affinity

the cpu number to change to

Returns

The affinity mask of the CPU before the change

Definition at line 143 of file platform.c.

platform_restore_affinity()

void platform_restore_affinity

(

int64_t

affinity

)

Restore CPU affinity

If an OS requires the cores used by the user space thread to match on return from a call into the kernel (e.g. IOCTL), reset the affinity to it's previous state.

Parameters

affinity

the cpu affinity mask.

Definition at line 150 of file platform.c.