module ti.sdo.io.drivers.Generator

Generator module

C synopsis
Individual elements
XDCscript usage
Individual elements

Using this module clients can simulate a device with an input channel and an output channel. Generator channels are used to generate sequences of constants, sine waves, random noise, or other streams of data defined by a user function. [ more ... ]

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

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

Functions
Void	Generator_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(Generator_Params *params);
Void	Generator_simulateIsr// This function is used to give energy to the Generator driver to process its IO packets. It simulates real ISR(UArg arg);
Functions common to all IDriver modules
Void	Generator_close// Close a channel. Raises an error upon failure(Generator_Handle handle, Ptr chanHandle, Error_Block *eb);
Void	Generator_control// Send driver specific command to channel or associated device(Generator_Handle handle, Ptr chanHandle, DriverTypes_ControlCmd cmd, UArg cmdArgs, Error_Block *eb);
Ptr	Generator_open// Open a channel(Generator_Handle handle, String name, UInt mode, UArg chanParams, DriverTypes_DoneFxn cbFxn, UArg cbArg, Error_Block *eb);
UInt	Generator_submit// Submit io packet to a channel. This may result in a callback(Generator_Handle handle, Ptr chanHandle, DriverTypes_Packet packet, Error_Block eb);
Functions common to all target instances
	Generator_handle// Convert this instance structure pointer into an instance handle, Generator_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, Generator_Handle_label// The label associated with this instance object, Generator_Handle_name// The name of this instance object, Generator_Handle_upCast// unconditionally move one level up the inheritance hierarchy, Generator_Object_count// The number of statically-created instance objects, Generator_Object_first// The handle of the first dynamically-created instance object, or NULL, Generator_Object_get// The handle of the i-th statically-created instance object (array == NULL), Generator_Object_heap// The heap used to allocate dynamically-created instance objects, Generator_Object_next// The handle of the next dynamically-created instance object, or NULL, Generator_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	Generator_Module_getMask// Returns the diagnostics mask for this module, Generator_Module_hasMask// Test whether this module has a diagnostics mask, Generator_Module_heap// The heap from which this module allocates memory, Generator_Module_id// Get this module's unique id, Generator_Module_setMask// Set the diagnostics mask for this module, Generator_Module_startupDone// Test if this module has completed startup
Defines
#define	Generator_NUMCHANS// Number of channels per generator device (Int)2
Typedefs
typedef struct	Generator_ChanParams// Channel parameters used along with open ...
typedef Void	(*Generator_GenFunc// typedef for user specified I/O generators)(Ptr,SizeT,UArg);
typedef Generator_Object *	Generator_Handle// Client reference to an instance object;
typedef struct	Generator_Object// Opaque internal representation of an instance object Generator_Object;
typedef struct	Generator_Params// Instance config-params structure ...
typedef struct	Generator_Struct// Opaque client structure large enough to hold an instance object Generator_Struct;
Constants
extern const Error_Id	Generator_E_nullParams// Error raised when NULL chanParams is specified;

DETAILS

When a channel is opened, the user gets to specify a function to simulate the input channel and a function to simulate the output channel characteristics.

The Generator module can be configured to process the io just like a real driver, where a submit call will return pending and io will be completed in the context of an isr. This mode is called returnPending. However the user has to call simulateIsrFxn in an isr, Swi or a Task to support this mode. In simulateIsr, one pending IO Packet for both channel for all Generator instances is processed.

const Generator_NUMCHANS