Data Structures | Typedefs | Enumerations | Functions
consumer.h File Reference

This is a very slim consumer framework library implementation. More...

#include <ti/instrumentation/traceframework/trace_contract.h>

Data Structures

struct  consRegNotify
 Consumer Notify glue structure. More...
struct  consNotify
 Consumer Notify Structure (IPC kind or Local Call back. More...
struct  consConfig
 Structure with consumer NetCp config. More...

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 void * tf_cons_HANDLE
 Consumer Handle.
typedef struct consRegNotify tf_consRegNotify_t
 Consumer Notify glue structure.
typedef struct consNotify tf_consNotify_t
 Consumer Notify Structure (IPC kind or Local Call back.
typedef struct consConfig tf_consConfig_t
 Structure with consumer NetCp config.

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...

Functions

uint32_t tf_isThereToConsume (tf_consumer_HANDLE cHandle)
tf_consStatus_e tf_consProcess (tf_consumer_HANDLE cHandle)
tf_consStatus_e tf_consAck (tf_consumer_HANDLE cHandle)
tf_consStatus_e tf_consDestroy (tf_consumer_HANDLE cHandle)
tf_consumer_HANDLE tf_consCreate (tf_consConfig_t config)
tf_consStatus_e tf_consumerForceFreezeProducer (tf_cons_HANDLE cHandle)
tf_consStatus_e tf_consumerGetContractHandle (tf_cons_HANDLE cHandle, tf_contract_HANDLE *contract_handle)
tf_consStatus_e tf_alignConsumer2FrozenProd (tf_consumer_HANDLE cHandle)

Detailed Description

This is a very slim consumer framework library implementation.

============================================================================
(C) Copyright 2012, Texas Instruments, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Copyright 2014, Texas Instruments Incorporated