AR Osal Types - Qualcomm Dragonwing Documentation

Header: ar_osal/api/ar_osal_types.h

Type Definitions

`char_t`

else of defined(H2XML)

typedef char char_t

`bool_t`

Boolean value type.

typedef unsigned char bool_t

Macros

`FALSE`

#define FALSE 0

`TRUE`

#define TRUE 1

`PAGED_FUNCTIONS_START`

PAGING functiona and data.

#define PAGED_FUNCTIONS_START

`PAGED_FUNCTIONS_END`

Should be used at the end of functions group to be paged.

#define PAGED_FUNCTIONS_END

`PAGED_FUNCTION`

Should be used at the start of the paged function definition.

#define PAGED_FUNCTION

`PAGED_DATA_START`

Paged Data.

#define PAGED_DATA_START

`PAGED_DATA_END`

Should be used at the end of the variables group to be paged.

#define PAGED_DATA_END

`__UNREFERENCED_PARAM`

#define __UNREFERENCED_PARAM

`__UNUSED`

#define __UNUSED

`_In_`

Function parameter annotations.

#define _In_

`_In_opt_`

This parameter may not have valid value and will not be changed by the function.

#define _In_opt_

`_Out_`

This parameter does not have a valid value, but must be a valid value after the function call returns.

#define _Out_

`_Out_opt_`

This parameter does not have a valid value before and after the function call returns.

#define _Out_opt_

`_Inout_`

This parameter must have a valid value before and should have a different value after the function call returns.

#define _Inout_

`_Inout_opt_`

This parameter may not have a valid value before and after the function call returns.

#define _Inout_opt_

`_Outptr_`

This Parameter cannot be null and should have a valid pointer to location after the function call returns.

#define _Outptr_

`_Outptr_opt_`

This Parameter can be null and should have a valid pointer to location after the function call returns.

#define _Outptr_opt_

`_IRQL_requires_max_`

Interrupt request level(IRQL)

#define _IRQL_requires_max_

`_IRQL_requires_min_`

#define _IRQL_requires_min_

`PASSIVE_LEVEL`

Normal priority level.

#define PASSIVE_LEVEL

`DISPATCH_LEVEL`

Runs at high priority level, these functions should not be paged.

#define DISPATCH_LEVEL

​Type Definitions

​char_t

​bool_t

​Macros

​FALSE

​TRUE

​PAGED_FUNCTIONS_START

​PAGED_FUNCTIONS_END

​PAGED_FUNCTION

​PAGED_DATA_START

​PAGED_DATA_END

​__UNREFERENCED_PARAM

​__UNUSED

​_In_

​_In_opt_

​_Out_

​_Out_opt_

​_Inout_

​_Inout_opt_

​_Outptr_

​_Outptr_opt_

​_IRQL_requires_max_

​_IRQL_requires_min_

​PASSIVE_LEVEL

​DISPATCH_LEVEL