RtndStartInterface

RtndStartInterface starts an interface.

Syntax

Copy
BOOL RtndStartInterface(
  [in]            ULONG_PTR RtndInterfaceId,
  [in, ignored]   ULONG Flags
);

Parameters

[in] RtndInterfaceId

The number or pointer used to identify the interface. This value is returned by RtndManageInterface.

[in, ignored] Flags

Reserved for future use. The value is set to zero by the NL2. Drivers must ignore this parameter.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. To get extended error information, call GetLastError.

Common error codes:

Error code Meaning

ERROR_OUTOFMEMORY

Failed to allocate the required memory.

ERROR_OPEN_FAILED

Generic error while trying to start the device.

ERROR_IO_DEVICE

An unexpected error occurred while trying to access the device.

ERROR_RESOURCE_NOT_AVAILABLE

Needed hardware resource unexpectedly unavailable.

RT_ERROR_INCORRECT_INTERRUPT_TYPE

The requested interrupt type can't be set because the hardware doesn't support it, or the hardware is not ready to support it now (e.g. the CPU doesn’t have enough free vectors).

RT_FAILED_TO_ATTACH_INTERRUPT

Failed to attach the device’s interrupt.

Note: Custom drivers may return other error codes not listed above.

Remarks

The NL2 always calls this function from the main thread of the NL2 process.

Characteristics

Real-time requirements

Deterministic behavior

Not required

Local memory allocation/deallocation restrictions

Process

External MSpace

Internal MSpace

System

Allowed

Allowed

Process

Allowed

Allowed

Contiguous memory allocation/deallocation restrictions

Contiguous memory

Allowed

Requirements

Minimum supported version Header

eRTOS 1.0 SDK

Rtnd.h

See Also: