Typedefs | Enumerations
Trace Framework Enumerations
Trace Framework Control Bit map Definitions

Typedefs

typedef enum consStatus tf_consStatus_e
 Enumerations showing the consumer status.
typedef enum consAppSendRespStatus tf_consAppSendRespStatus_e
 Enumerations showing the application send information to the traceframework library.
typedef enum prodException tf_prodException_e
 Producer Exception enumerations.
typedef enum prodStatus tf_prodStatus_e
 Producer Status enumerations.

Enumerations

enum  tf_notifyTypes_e { TF_CONSUMER_NOTIFY_VIA_REGMASK = 0x0, TF_CONSUMER_NOTIFY_VIA_LOCCBK = 0x1, TF_CONSUMER_NOTIFY_NONE = 0x2, TF_CONSUMER_NOTIFY_VIA_LOCCBK2 = 0x3 }
 Trace framework Producer-Consumer NOTIFY types. More...
enum  consStatus {
  TF_CONSUMER_NO_AVAILABLE_CONTRACT = 0, TF_CONSUMER_INVALID_ARGUMENTS, TF_CONSUMER_SUCCESS, TF_CONSUMER_FAIL,
  TF_CONSUMER_WAIT_ACK, TF_CONSUMER_ACK_RECIVED, TF_CONSUMER_NOTHING_TO_CONSUME, TF_CONSUMER_INVALID_HANDLE,
  TF_CONSUMER_INVALID_CONTRACT_HANDLE
}
 Enumerations showing the consumer status. More...
enum  consAppSendRespStatus { TF_CONSUMER_APP_SEND_OK_WAIT_ACK, TF_CONSUMER_APP_SEND_OK_NO_WAIT_ACK, TF_CONSUMER_APP_SEND_NOK_RETRY }
 Enumerations showing the application send information to the traceframework library. More...
enum  prodException { TF_PRODUCER_EXCEPTION_NOTIFY_FAIL = 0, TF_PRODUCER_EXCEPTION_INVALID_NOTIFY }
 Producer Exception enumerations. More...
enum  prodStatus {
  TF_PRODUCER_NO_AVAILABLE_CONTRACT = 0, TF_PRODUCER_INVALID_CONTRACT_HANDLE, TF_PRODUCER_INVALID_PRODID, TF_PRODUCER_PROD_SUCCESS,
  TF_PRODUCER_MAX_SUPPORTED_CONSUMERS_REACHED, TF_PRODUCER_PROD_FAIL, TF_PRODUCER_INVALID_HANDLE
}
 Producer Status enumerations. More...
enum  tf_producerTypes_e { TF_PRODUCER_TYPE_UIA = 0x1<<0, TF_PRODUCER_TYPE_GEN = 0x1<<1, TF_PRODUCER_TYPE_UIA_MINST = 0x1<<2, TF_PRODUCER_TYPE_CUIA = 0x1<<3 }
 Producer types supported in trace framework. More...
enum  tf_contractState_e { TF_CONTRACT_AVAILABLE = 0x55555555, TF_CONTRACT_NOT_AVAILABLE = 0x0 }
 Contract State added here When contracts are newly created, they are marked Available and as and when the contracts are used between producers and consumer instances, they would be marked as not available. More...
enum  tf_contractVersion_e { TF_CONTRACT_VERSION_2 = 0x66666666, TF_CONTRACT_VERSION_1 = 0x0, TF_CONTRACT_VERSION_UNKNOWN = 0xf05d }
 Contract Versions added here Contract Version number signifies the set of APIs to be used There are few APIs marked in the traceframework functions, which are deprecated for contract version 1. More...
enum  tf_contractType_e { TF_CONTRACT_DSP_ARM = 0, TF_CONTRACT_STREAM_FREEZE_PRODUCER = TF_CONTRACT_DSP_ARM, TF_CONTRACT_ARM_ARM = 1 }
 Contract Types added here Trace framework can support multiple contract types such as 1. Contracts having streaming producer always ( can have 4 consumers maximum) 2. Contracts having stream/freeze producer (supports only one consumer per contract) More...
enum  tf_ringBufAddrType_e { TF_CONTRACT_RING_BUF_PHYSICAL_ADDR = 0, TF_CONTRACT_RING_BUF_NOT_PHYSICAL_ADDR = 1 }
 Trace Framework Ring Buffer Address type. More...
enum  tf_contractBufAddrType_e { TF_CONTRACT_BUF_PHYSICAL_ADDR = 0, TF_CONTRACT_BUF_NOT_PHYSICAL_ADDR = 1 }
 Trace Framework Contract Buffer Address type. More...

Enumeration Type Documentation

Enumerations showing the application send information to the traceframework library.

Enumerator:
TF_CONSUMER_APP_SEND_OK_WAIT_ACK 

Application sent the passed buffer succesfully and frees up the buffer for the library during ACK

TF_CONSUMER_APP_SEND_OK_NO_WAIT_ACK 

Application sent the passed buffer succesfully and frees up the buffer for the library immediately

TF_CONSUMER_APP_SEND_NOK_RETRY 

Application did not sent the passed buffer succesfully and would like to retry sometime later in time

enum consStatus

Enumerations showing the consumer status.

Enumerator:
TF_CONSUMER_NO_AVAILABLE_CONTRACT 

No avilable contract for the consumer

TF_CONSUMER_INVALID_ARGUMENTS 

Invalid arguments are passed for the consumer

TF_CONSUMER_SUCCESS 

Success in consumer operations

TF_CONSUMER_FAIL 

failure in consumer operations

TF_CONSUMER_WAIT_ACK 

Consumer is busy in the operation, waiting for the Ack

TF_CONSUMER_ACK_RECIVED 

Consumer got the ACK from the System

TF_CONSUMER_NOTHING_TO_CONSUME 

nothing to consume in consumer operations

TF_CONSUMER_INVALID_HANDLE 

Invalid consumer handle is provided

TF_CONSUMER_INVALID_CONTRACT_HANDLE 

Invalid contract handle is noticed in consumer instance

Producer Exception enumerations.

Enumerator:
TF_PRODUCER_EXCEPTION_NOTIFY_FAIL 

Producer failed to write to the notify register address with the register mask

TF_PRODUCER_EXCEPTION_INVALID_NOTIFY 

Invalid notify option is passed

enum prodStatus

Producer Status enumerations.

Enumerator:
TF_PRODUCER_NO_AVAILABLE_CONTRACT 

There is no contract available for the producer

TF_PRODUCER_INVALID_CONTRACT_HANDLE 

Invalid Contract handle is noticed in the producer

TF_PRODUCER_INVALID_PRODID 

Invalid producer Id is noticed

TF_PRODUCER_PROD_SUCCESS 

Producer ended up with a successful operation

TF_PRODUCER_MAX_SUPPORTED_CONSUMERS_REACHED 

Producer reached maximum number of consumers

TF_PRODUCER_PROD_FAIL 

Producer ended up with an unsuccessful operation

TF_PRODUCER_INVALID_HANDLE 

Invalid producer handle

Trace Framework Contract Buffer Address type.

Enumerator:
TF_CONTRACT_BUF_PHYSICAL_ADDR 

trace framework contract buffer address configured is physical memory

TF_CONTRACT_BUF_NOT_PHYSICAL_ADDR 

trace framework contract buffer address configured is not physical memory

Contract State added here When contracts are newly created, they are marked Available and as and when the contracts are used between producers and consumer instances, they would be marked as not available.

Enumerator:
TF_CONTRACT_AVAILABLE 

tf_contract slot is available

TF_CONTRACT_NOT_AVAILABLE 

tf_contract slot is not available

Contract Types added here Trace framework can support multiple contract types such as 1. Contracts having streaming producer always ( can have 4 consumers maximum) 2. Contracts having stream/freeze producer (supports only one consumer per contract)

Enumerator:
TF_CONTRACT_DSP_ARM 

tf_contract between DSP and ARM, where ARM has consumer for DSP producer

TF_CONTRACT_STREAM_FREEZE_PRODUCER 

tf_contract has stream/freeze producer, this is same as DSP ARM contract, kept for backwards compatibility

TF_CONTRACT_ARM_ARM 

tf_contract between ARM and ARM, where ARM has both producer and consumers

Contract Versions added here Contract Version number signifies the set of APIs to be used There are few APIs marked in the traceframework functions, which are deprecated for contract version 1.

Enumerator:
TF_CONTRACT_VERSION_2 

trace framework contract version 2 (no named contracts and they can be created as and when needed

TF_CONTRACT_VERSION_1 

trace framework contract version 1 (Legacy mode, all system contracts are named, and they are initialized and created at one time and declared as AVAILABLE)

TF_CONTRACT_VERSION_UNKNOWN 

Unknown Contract Version which Trace Framework can not understand

Trace framework Producer-Consumer NOTIFY types.

Enumerator:
TF_CONSUMER_NOTIFY_VIA_REGMASK 

Notify the consumer task in the application with IPC kind of mechanism

TF_CONSUMER_NOTIFY_VIA_LOCCBK 

notify the task using a local call back function

TF_CONSUMER_NOTIFY_NONE 

no notify method, consumers can have their own method to check for new buffers

TF_CONSUMER_NOTIFY_VIA_LOCCBK2 

notify the task using a local call back2 function

Producer types supported in trace framework.

Enumerator:
TF_PRODUCER_TYPE_UIA 

used for creating UIA producer ID

TF_PRODUCER_TYPE_GEN 

used for creating General producer ID

TF_PRODUCER_TYPE_UIA_MINST 

used for creating Multi-instance UIA producer ID

TF_PRODUCER_TYPE_CUIA 

used for creating CUIA producer ID

Trace Framework Ring Buffer Address type.

Enumerator:
TF_CONTRACT_RING_BUF_PHYSICAL_ADDR 

trace framework contract ring buffer address configured is physical memory

TF_CONTRACT_RING_BUF_NOT_PHYSICAL_ADDR 

trace framework contract ring buffer address configured is not physical memory


Copyright 2014, Texas Instruments Incorporated