rtapi_module_param

NAME
SYNTAX
ARGUMENTS
DESCRIPTION
NOTES
REALTIME CONSIDERATIONS

NAME

rtapi_module_param − Specifying module parameters

SYNTAX

RTAPI_MP_INT(var, description)

RTAPI_MP_LONG(var, description)

RTAPI_MP_STRING(var, description)

RTAPI_MP_ARRAY_INT(var, num, description)

RTAPI_MP_ARRAY_LONG(var, num, description)

RTAPI_MP_ARRAY_STRING(var, num, description)

MODULE_LICENSE(license)

MODULE_AUTHOR(author)

MODULE_DESCRIPTION(description)

EXPORT_FUNCTION(function)

ARGUMENTS

var

The variable where the parameter should be stored

description

A short description of the parameter or module

num

The maximum number of values for an array parameter

license

The license of the module, for instance "GPL"

author

The author of the module

function

The pointer to the function to be exported

DESCRIPTION

These macros are portable ways to declare kernel module parameters. They must be used in the global scope, and are not followed by a terminating semicolon. They must be used after the associated variable or function has been defined.

NOTES

EXPORT_FUNCTION makes a symbol available for use by a subsequently loaded component. It is unrelated to hal functions, which are described in hal_export_funct(3hal)

REALTIME CONSIDERATIONS

Not available in userspace code.