DRV_MX25L_Open Function

C

DRV_HANDLE DRV_MX25L_Open( const SYS_MODULE_INDEX drvIndex, const DRV_IO_INTENT ioIntent );

Summary

Opens the specified MX25L driver instance and returns a handle to it

Description

This routine opens the specified MX25L driver instance and provides a handle.

This handle must be provided to all other client-level operations to identify the caller and the instance of the driver.

Preconditions

Function DRV_MX25L_Initialize must have been called before calling this function. Driver should be in ready state to accept the request. Can be checked by calling DRV_MX25L_Status().

Parameters


Param	Description
drvIndex	Identifier for the instance to be opened
ioIntent	Zero or more of the values from the enumeration DRV_IO_INTENT "ORed" together to indicate the intended use of the driver

Returns

If successful, the routine returns a valid open-instance handle (a number identifying both the caller and the module instance).

If an error occurs, DRV_HANDLE_INVALID is returned. Errors can occur under the following circumstances:

if the driver hardware instance being opened is not initialized.

Example

DRV_HANDLE handle;

handle = DRV_MX25L_Open(DRV_MX25L_INDEX);
if (DRV_HANDLE_INVALID == handle)
{
    // Unable to open the driver
}

Remarks

The handle returned is valid until the DRV_MX25L_Close routine is called.

If the driver has already been opened, it should not be opened again.