module ti.sdo.io.drivers.IomAdapter

Module through which legacy iom drivers can plug into BIOS 6.x

C synopsis
Individual elements
XDCscript usage
Individual elements

The IomAdapter module maps iom.h to IDriver.xdc. A legacy iom driver has to hook into BIOS 6.x using this module. This module handles ALL legacy drivers in the system. This single module takes care of several legacy driver modules. [ more ... ]

C synopsis target-domain sourced in ti/sdo/io/drivers/IomAdapter.xdc

#include <ti/sdo/io/drivers/IomAdapter.h>

Functions
Void	IomAdapter_construct// Initialize a new instance object inside the provided structure(IomAdapter_Struct structP, const IomAdapter_Params params);
IomAdapter_Handle	IomAdapter_create// Allocate and initialize a new instance object and return its handle(const IomAdapter_Params params, Error_Block eb);
Void	IomAdapter_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(IomAdapter_Handle *handleP);
Void	IomAdapter_destruct// Finalize the instance object inside the provided structure(IomAdapter_Struct *structP);
Void	IomAdapter_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(IomAdapter_Params *params);
Functions common to all IDriver modules
Void	IomAdapter_close// Close a channel. Raises an error upon failure(IomAdapter_Handle handle, Ptr chanHandle, Error_Block *eb);
Void	IomAdapter_control// Send driver specific command to channel or associated device(IomAdapter_Handle handle, Ptr chanHandle, DriverTypes_ControlCmd cmd, UArg cmdArgs, Error_Block *eb);
Ptr	IomAdapter_open// Open a channel(IomAdapter_Handle handle, String name, UInt mode, UArg chanParams, DriverTypes_DoneFxn cbFxn, UArg cbArg, Error_Block *eb);
UInt	IomAdapter_submit// Submit io packet to a channel. This may result in a callback(IomAdapter_Handle handle, Ptr chanHandle, DriverTypes_Packet packet, Error_Block eb);
Functions common to all target instances
	IomAdapter_handle// Convert this instance structure pointer into an instance handle, IomAdapter_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, IomAdapter_Handle_label// The label associated with this instance object, IomAdapter_Handle_name// The name of this instance object, IomAdapter_Handle_upCast// unconditionally move one level up the inheritance hierarchy, IomAdapter_Object_count// The number of statically-created instance objects, IomAdapter_Object_first// The handle of the first dynamically-created instance object, or NULL, IomAdapter_Object_get// The handle of the i-th statically-created instance object (array == NULL), IomAdapter_Object_heap// The heap used to allocate dynamically-created instance objects, IomAdapter_Object_next// The handle of the next dynamically-created instance object, or NULL, IomAdapter_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	IomAdapter_Module_getMask// Returns the diagnostics mask for this module, IomAdapter_Module_hasMask// Test whether this module has a diagnostics mask, IomAdapter_Module_heap// The heap from which this module allocates memory, IomAdapter_Module_id// Get this module's unique id, IomAdapter_Module_setMask// Set the diagnostics mask for this module, IomAdapter_Module_startupDone// Test if this module has completed startup
Typedefs
typedef IomAdapter_Object *	IomAdapter_Handle// Client reference to an instance object;
typedef Void	(*IomAdapter_InitFunc// Iom init function type definition)();
typedef struct	IomAdapter_Object// Opaque internal representation of an instance object IomAdapter_Object;
typedef struct	IomAdapter_Params// Instance config-params structure ...
typedef struct	IomAdapter_Struct// Opaque client structure large enough to hold an instance object IomAdapter_Struct;

DETAILS

As part of its create the IomAdapter module will call mbBindDev for each of the legacy drivers. open will call mdCreateChan. close will call mdDeleteChan. submit will call mdSubmitChan. control will call mdControlChan. A delete call will call mdUnbindDev.

typedef IomAdapter_InitFunc