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

This is a very slim ring producer framework library implementation. More...

#include "ti/instrumentation/traceframework/trace_contract.h"

Data Structures

struct  prodConfig
 Structure with producer config. More...

Typedefs

typedef enum prodException tf_prodException_e
 Producer Exception enumerations.
typedef enum prodStatus tf_prodStatus_e
 Producer Status enumerations.
typedef void * tf_producer_HANDLE
 Producer handle.
typedef struct prodConfig tf_prodConfig_t
 Structure with producer config.

Enumerations

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_producerState_e {
  TF_PRODUCER_STATE_INVALID = -1, TF_PRODUCER_STATE_STREAMING = 0, TF_PRODUCER_STATE_FREE_RUNNING, TF_REQUEST_PRODUCER_STATE_FREEZING,
  TF_PRODUCER_STATE_FROZEN
}
 Producer State in Contract. More...
enum  tf_producerResponseState_e { TF_PRODUCER_RESPONSE_STATE_ACK_FREEZE_REQ = TF_PRODUCER_STATE_FROZEN }
 Producer Response States. More...
enum  tf_producerRequestState_e { TF_PRODUCER_STATE_PROCESS_FREEZE_REQ = TF_REQUEST_PRODUCER_STATE_FREEZING }
 Producer Request States. More...

Functions

void tf_prodNotifyConsumers (tf_producer_HANDLE pHandle)
int32_t tf_prodUpdateConsumers (tf_producer_HANDLE p_handle)
tf_prodStatus_e tf_prodDestroy (tf_producer_HANDLE pHandle)
tf_producer_HANDLE tf_prodCreate (tf_prodConfig_t config)
void * tf_prodGetCurBuf (tf_producer_HANDLE pHandle)
Ptr tf_prodBufExchange (tf_producer_HANDLE pHandle, uint8_t *full)
void tf_prodSetOOBData (tf_contract_HANDLE cHandle, uint8_t *data)
void tf_prodGetOOBData (tf_contract_HANDLE cHandle, uint8_t *data)
tf_prodStatus_e tf_prodGetContractHandle (tf_producer_HANDLE pHandle, tf_contract_HANDLE *contract_handle)

Detailed Description

This is a very slim ring producer 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