module ti.uiactools.services.BufferUpload |

index URL

- C synopsis
- Individual elements
- XDCscript usage
- Individual elements

`C` synopsis | target-domain | sourced in ti/uiactools/services/BufferUpload.xdc

``#include <ti/uiactools/services/BufferUpload.h>

Functions
``Void | BufferUpload_disableAllBuffers// Function to disable all the buffer packetizers being processed by BufferUpload();
``Void | BufferUpload_enableAllBuffers// Function to enable all the buffer packetizers being processed by BufferUpload();
``Bool | BufferUpload_isDataTx// returns true if DataTx is active();
``Ptr | BufferUpload_packetBufferExchange// Exchange function called by the buffer packetizer when it has a packet of buffer data ready to send(Ptr hBufferPacketizer, Ptr full);
``Void | BufferUpload_resetAllBuffers// Function to reset all the buffer packetizers being processed by BufferUpload();
``Void | BufferUpload_snapshotAllBuffers// Function to delay processing of the BufferUpload service(UArg reset, UArg waitPeriod);
``Void | BufferUpload_startDataTx// Function to start the BufferUpload service();
``Void | BufferUpload_stopDataTx// Function to stop the BufferUpload service();
Functions common to all target modules
| BufferUpload_Module_getMask// Returns the diagnostics mask for this module, BufferUpload_Module_hasMask// Test whether this module has a diagnostics mask, BufferUpload_Module_heap// The heap from which this module allocates memory, BufferUpload_Module_id// Get this module's unique id, BufferUpload_Module_setMask// Set the diagnostics mask for this module, BufferUpload_Module_startupDone// Test if this module has completed startup
Typedefs
``typedef struct | BufferUpload_Packet// ...
Constants
``extern const Log_Event | BufferUpload_LD_cmdRcvd// Logged when the Rta receives a command;
``extern const Log_Event | BufferUpload_LD_recordsSent// Logged on every packet is sent call from the Rta;
``extern const Int | BufferUpload_periodInMs// Period in miliseconds of the BufferUpload Transfer Agent Task;

struct BufferUpload_Packet |

index URL

`C` synopsis | target-domain

````typedef struct BufferUpload_Packet {
```` UIAPacket_Hdr hdr;
```` Bits32 arg0;
```` Bits32 arg1;
````} BufferUpload_Packet;

config BufferUpload_LD_cmdRcvd // module-wide |

index URL

Logged when the Rta receives a command

`C` synopsis | target-domain

````extern const Log_Event BufferUpload_LD_cmdRcvd;

config BufferUpload_LD_recordsSent // module-wide |

index URL

Logged on every packet is sent call from the Rta

`C` synopsis | target-domain

````extern const Log_Event BufferUpload_LD_recordsSent;

config BufferUpload_periodInMs // module-wide |

index URL

Period in miliseconds of the BufferUpload Transfer Agent Task

`C` synopsis | target-domain

````extern const Int BufferUpload_periodInMs;
DETAILS
Configures how often the BufferUpload should collect events. The minimum value is 100ms.
This value does not guarantee that the collection will run at this rate. Even if the period has expired, the collection will not occur until the current running Task has yielded and there are no other higher priority Tasks ready.
Setting the period to 0, disables all collection of events. There must be a setPeriod message sent from an instrumentation host to BufferUpload to enable it.
Default is 100 milliseconds.

BufferUpload_disableAllBuffers() // module-wide |

index URL

Function to disable all the buffer packetizers being processed by BufferUpload

`C` synopsis | target-domain

````Void BufferUpload_disableAllBuffers();
DETAILS
Runtime function to disable all the logs that are being processed/read by BufferUpload. When disabled, all new Etb records are discarded.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests.

BufferUpload_enableAllBuffers() // module-wide |

index URL

Function to enable all the buffer packetizers being processed by BufferUpload

`C` synopsis | target-domain

````Void BufferUpload_enableAllBuffers();
DETAILS
Runtime function to enable disable all the logs that are being processed/read by BufferUpload.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests

BufferUpload_isDataTx() // module-wide |

index URL

returns true if DataTx is active

`C` synopsis | target-domain

````Bool BufferUpload_isDataTx();

BufferUpload_packetBufferExchange() // module-wide |

index URL

Exchange function called by the buffer packetizer when it has a packet of buffer data ready to send

`C` synopsis | target-domain

````Ptr BufferUpload_packetBufferExchange(Ptr hBufferPacketizer, Ptr full);

BufferUpload_resetAllBuffers() // module-wide |

index URL

Function to reset all the buffer packetizers being processed by BufferUpload

`C` synopsis | target-domain

````Void BufferUpload_resetAllBuffers();
DETAILS
Runtime function to enable resets all the buffer packetizers that are being processed/read by BufferUpload. The state of the buffer packetizers (e.g. enabled or disabled) are not changed.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests

BufferUpload_snapshotAllBuffers() // module-wide |

index URL

Function to delay processing of the BufferUpload service

`C` synopsis | target-domain

````Void BufferUpload_snapshotAllBuffers(UArg reset, UArg waitPeriod);
ARGUMENTS
reset — Flag to denote whether to reset the etbs or not. TRUE means reset all the etbs processed by BufferUpload. FALSE means do not reset any of the etbs processed by BufferUpload.
waitPeriod — Duration in milliseconds to wait to run the BufferUpload service.
DETAILS
This function informs BufferUpload to delay for the specified waitPeriod (in ms). After the waitPeriod has expired, BufferUpload will process all the etbs that it manages. The state of BufferUpload (e.g. started or stopped) will be maintained after the waitPeriod is expired and all the logs processed.
The reset flag determines whether to reset all the etbs at the start of the waitPeriod (true -> reset). The state of the etbs (e.g. enabled or disabled) is not changed by this flag.

BufferUpload_startDataTx() // module-wide |

index URL

Function to start the BufferUpload service

`C` synopsis | target-domain

````Void BufferUpload_startDataTx();
DETAILS
This function allows the BufferUpload service to be turned on.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests

BufferUpload_stopDataTx() // module-wide |

index URL

Function to stop the BufferUpload service

`C` synopsis | target-domain

````Void BufferUpload_stopDataTx();
DETAILS
This function allows the BufferUpload service to be turned off.
Please realize that external instrumentation host (e.g. System Analyzer) might be sending down similar requests

Module-Wide Built-Ins |

index URL

`C` synopsis | target-domain

````Types_ModuleId BufferUpload_Module_id();
````// Get this module's unique id
````Bool BufferUpload_Module_startupDone();
````// Test if this module has completed startup
````IHeap_Handle BufferUpload_Module_heap();
````// The heap from which this module allocates memory
````Bool BufferUpload_Module_hasMask();
````// Test whether this module has a diagnostics mask
````Bits16 BufferUpload_Module_getMask();
````// Returns the diagnostics mask for this module
````Void BufferUpload_Module_setMask(Bits16 mask);
````// Set the diagnostics mask for this module

`XDCscript` usage | meta-domain | sourced in ti/uiactools/services/BufferUpload.xdc

``var BufferUpload = xdc.useModule('ti.uiactools.services.BufferUpload');
module-wide constants & types
`` ``var obj = new BufferUpload.Packet// ;
`` `` obj.hdr = UIAPacket.Hdr ...
`` `` obj.arg0 = Bits32 ...
`` `` obj.arg1 = Bits32 ...
module-wide config parameters
`` ``BufferUpload.LD_cmdRcvd// Logged when the Rta receives a command = Log.EventDesc {
`` `` mask: Diags.USER2,
`` `` msg: "BufferUpload LD_cmdRcvd: Received command: %d, arg0: 0x%x, arg1: 0x%x"
`` ``};
`` ``BufferUpload.LD_recordsSent// Logged on every packet is sent call from the Rta = Log.EventDesc {
`` `` mask: Diags.USER2,
`` `` msg: "BufferUpload LD_recordsSent: Sent %d bytes from logger [%d] 0x%x"
`` ``};
`` ``BufferUpload.periodInMs// Period in miliseconds of the BufferUpload Transfer Agent Task = Int 100;
`` ``BufferUpload.common$// Common module configuration parameters = Types.Common$ undefined;

struct BufferUpload.Packet |

index URL

`XDCscript` usage | meta-domain

````var obj = new BufferUpload.Packet;
```` obj.hdr = UIAPacket.Hdr ...
```` obj.arg0 = Bits32 ...
```` obj.arg1 = Bits32 ...
C SYNOPSIS
BufferUpload_Packet

config BufferUpload.LD_cmdRcvd // module-wide |

index URL

Logged when the Rta receives a command

`XDCscript` usage | meta-domain

````BufferUpload.LD_cmdRcvd = Log.EventDesc {
```` mask: Diags.USER2,
```` msg: "BufferUpload LD_cmdRcvd: Received command: %d, arg0: 0x%x, arg1: 0x%x"
````};
C SYNOPSIS
BufferUpload_LD_cmdRcvd

config BufferUpload.LD_recordsSent // module-wide |

index URL

Logged on every packet is sent call from the Rta

`XDCscript` usage | meta-domain

````BufferUpload.LD_recordsSent = Log.EventDesc {
```` mask: Diags.USER2,
```` msg: "BufferUpload LD_recordsSent: Sent %d bytes from logger [%d] 0x%x"
````};
C SYNOPSIS
BufferUpload_LD_recordsSent

config BufferUpload.periodInMs // module-wide |

index URL

Period in miliseconds of the BufferUpload Transfer Agent Task

`XDCscript` usage | meta-domain

````BufferUpload.periodInMs = Int 100;
DETAILS
Configures how often the BufferUpload should collect events. The minimum value is 100ms.
This value does not guarantee that the collection will run at this rate. Even if the period has expired, the collection will not occur until the current running Task has yielded and there are no other higher priority Tasks ready.
Setting the period to 0, disables all collection of events. There must be a setPeriod message sent from an instrumentation host to BufferUpload to enable it.
Default is 100 milliseconds.
C SYNOPSIS
BufferUpload_periodInMs

metaonly config BufferUpload.common$ // module-wide |

index URL

Common module configuration parameters

`XDCscript` usage | meta-domain

````BufferUpload.common$ = Types.Common$ undefined;
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
generated on Wed, 27 Jun 2012 04:11:43 GMT