Ctools Use Case Library
Macros
CTOOLS_USECASE Symbols Defined

Macros

#define CTOOLS_ETB_SIZE   4096
 
#define CTOOLS_MIN_DATA_SIZE   CTOOLS_ETB_SIZE
 
#define CTOOLS_BYTE_SWAP32(n)
 
#define CTOOLS_SOK   0
 
#define CTOOLS_EBASE   (-128)
 
#define CTOOLS_INVALID_PARAM   CTOOLS_EBASE-1
 
#define CTOOLS_NOT_INITIALIZED   CTOOLS_EBASE-2
 
#define CTOOLS_ETB_OPEN_ERROR   CTOOLS_EBASE-3
 
#define CTOOLS_ETB_ENABLE_ERROR   CTOOLS_EBASE-4
 
#define CTOOLS_ETB_FLUSH_ERROR   CTOOLS_EBASE-5
 
#define CTOOLS_ETB_FLUSHDMA_ERROR   CTOOLS_EBASE-6
 
#define CTOOLS_ETB_GETSTATUS_ERROR   CTOOLS_EBASE-7
 
#define CTOOLS_ETB_READ_ERROR   CTOOLS_EBASE-8
 
#define CTOOLS_ETB_DISABLE_ERROR   CTOOLS_EBASE-9
 
#define CTOOLS_ETB_CLOSE_ERROR   CTOOLS_EBASE-10
 
#define CTOOLS_ETB_GEN_ERROR   CTOOLS_EBASE-11
 
#define CTOOLS_DSPTRACE_OPEN_ERROR   CTOOLS_EBASE-12
 
#define CTOOLS_DSPTRACE_SETCLK_ERROR   CTOOLS_EBASE-13
 
#define CTOOLS_DSPTRACE_ENABLE_ERROR   CTOOLS_EBASE-14
 
#define CTOOLS_DSPTRACE_DISABLE_ERROR   CTOOLS_EBASE-15
 
#define CTOOLS_DSPTRACE_CLOSE_ERROR   CTOOLS_EBASE-16
 
#define CTOOLS_DSPTRACE_GEN_ERROR   CTOOLS_EBASE-17
 
#define CTOOLS_AET_CLAIM_ERROR   CTOOLS_EBASE-18
 
#define CTOOLS_AET_SETUPJOB_ERROR   CTOOLS_EBASE-19
 
#define CTOOLS_AET_RELJOB_ERROR   CTOOLS_EBASE-20
 
#define CTOOLS_AET_ENABLE_ERROR   CTOOLS_EBASE-21
 
#define CTOOLS_NOBUF_FOR_ETBDRAIN   CTOOLS_EBASE-22
 
#define CTOOLS_UNSUPPORTED   CTOOLS_EBASE-23
 
#define CTOOLS_RESOURCE_BUSY   CTOOLS_EBASE-24
 
#define CTOOLS_FILEOPERATION_ERR   CTOOLS_EBASE-25
 
#define CTOOLS_INVALID_CALL_SEQ   CTOOLS_EBASE-26
 
#define CTOOLS_CPT_ENABLE_ERROR   CTOOLS_EBASE-27
 
#define CTOOLS_CPT_SYSPROFILE_ERROR   CTOOLS_EBASE-28
 
#define CTOOLS_CPT_SYSPROFILE_BUSY   CTOOLS_EBASE-29
 
#define CTOOLS_CPT_EVTPROFILE_ERROR   CTOOLS_EBASE-30
 
#define CTOOLS_CPT_EVTPROFILE_BUSY   CTOOLS_EBASE-31
 
#define CTOOLS_CPT_ADDRFILTER_ERROR   CTOOLS_EBASE-32
 
#define CTOOLS_CPT_MASTERPROFILE_ERROR   CTOOLS_EBASE-33
 
#define CTOOLS_CPT_MASTERPROFILE_BUSY   CTOOLS_EBASE-34
 
#define CTOOLS_CPT_TOTALPROFILE_ERROR   CTOOLS_EBASE-35
 
#define CTOOLS_CPT_TOTALPROFILE_BUSY   CTOOLS_EBASE-36
 
#define CTOOLS_CPT_SINGLESTART_ERROR   CTOOLS_EBASE-37
 
#define CTOOLS_CPT_SINGLESTOP_ERROR   CTOOLS_EBASE-38
 
#define CTOOLS_CPT_SINGLECLOSE_ERROR   CTOOLS_EBASE-39
 
#define CTOOLS_CPT_NOT_OPEN   CTOOLS_EBASE-40
 
#define CTOOLS_CPT_NOT_STARTED   CTOOLS_EBASE-41
 
#define CTOOLS_SYSTEMTRACE_ENABLE_ERROR   CTOOLS_EBASE-42
 
#define CTOOLS_SYSETB_NOT_ENABLED   CTOOLS_EBASE-43
 
#define CTOOLS_DSPETB_NOT_ENABLED   CTOOLS_EBASE-44
 
#define CTOOLS_ETB_EDMA_DRAIN_NOT_SUPPORTED   CTOOLS_EBASE-45
 
#define CTOOLS_SYSETB_STOPBUF_NOT_SUPPORTED   CTOOLS_EBASE-46
 
#define CTOOLS_DSPTRACE_TEND_ERROR   CTOOLS_EBASE-47
 

Detailed Description

Macro Definition Documentation

#define CTOOLS_AET_CLAIM_ERROR   CTOOLS_EBASE-18

CTOOLS AET claim error

#define CTOOLS_AET_ENABLE_ERROR   CTOOLS_EBASE-21

CTOOLS AET enable error

#define CTOOLS_AET_RELJOB_ERROR   CTOOLS_EBASE-20

CTOOLS AET release job error

#define CTOOLS_AET_SETUPJOB_ERROR   CTOOLS_EBASE-19

CTOOLS AET setupjob error

#define CTOOLS_BYTE_SWAP32 (   n)
Value:
( ((((uint32_t) n) << 24) & 0xFF000000) | \
((((uint32_t) n) << 8) & 0x00FF0000) | \
((((uint32_t) n) >> 8) & 0x0000FF00) | \
((((uint32_t) n) >> 24) & 0x000000FF) )
CTOOLS_BYTE_SWAP32
if upload to file transport is enabled
#define CTOOLS_CPT_ADDRFILTER_ERROR   CTOOLS_EBASE-32

CTOOLS CP Tracer Address filter configuration error

#define CTOOLS_CPT_ENABLE_ERROR   CTOOLS_EBASE-27

CTOOLS CP Tracer Enable error, unable to enable CP tracer as system trace is not initialized

#define CTOOLS_CPT_EVTPROFILE_BUSY   CTOOLS_EBASE-31

CTOOLS CP Tracer Event profiling busy

#define CTOOLS_CPT_EVTPROFILE_ERROR   CTOOLS_EBASE-30

CTOOLS CP Tracer Event profiling error

#define CTOOLS_CPT_MASTERPROFILE_BUSY   CTOOLS_EBASE-34

CTOOLS CP Tracer Master profiling busy

#define CTOOLS_CPT_MASTERPROFILE_ERROR   CTOOLS_EBASE-33

CTOOLS CP Tracer Master profiling error

#define CTOOLS_CPT_NOT_OPEN   CTOOLS_EBASE-40

CTOOLS CP Tracer not open

#define CTOOLS_CPT_NOT_STARTED   CTOOLS_EBASE-41

CTOOLS CP Tracer not started

#define CTOOLS_CPT_SINGLECLOSE_ERROR   CTOOLS_EBASE-39

CTOOLS CP Tracer single close error

#define CTOOLS_CPT_SINGLESTART_ERROR   CTOOLS_EBASE-37

CTOOLS CP Tracer single start error

#define CTOOLS_CPT_SINGLESTOP_ERROR   CTOOLS_EBASE-38

CTOOLS CP Tracer single stop error

#define CTOOLS_CPT_SYSPROFILE_BUSY   CTOOLS_EBASE-29

CTOOLS CP Tracer System profiling busy

#define CTOOLS_CPT_SYSPROFILE_ERROR   CTOOLS_EBASE-28

CTOOLS CP Tracer System profiling error

#define CTOOLS_CPT_TOTALPROFILE_BUSY   CTOOLS_EBASE-36

CTOOLS CP Tracer Total profiling busy

#define CTOOLS_CPT_TOTALPROFILE_ERROR   CTOOLS_EBASE-35

CTOOLS CP Tracer Total profiling error

#define CTOOLS_DSPETB_NOT_ENABLED   CTOOLS_EBASE-44

CTOOLS DSP ETB not enabled

#define CTOOLS_DSPTRACE_CLOSE_ERROR   CTOOLS_EBASE-16

CTOOLS dsptrace close error

#define CTOOLS_DSPTRACE_DISABLE_ERROR   CTOOLS_EBASE-15

CTOOLS dsptrace disable error

#define CTOOLS_DSPTRACE_ENABLE_ERROR   CTOOLS_EBASE-14

CTOOLS dsptrace enable error

#define CTOOLS_DSPTRACE_GEN_ERROR   CTOOLS_EBASE-17

CTOOLS dsptrace general error

#define CTOOLS_DSPTRACE_OPEN_ERROR   CTOOLS_EBASE-12

CTOOLS dsptrace open error

#define CTOOLS_DSPTRACE_SETCLK_ERROR   CTOOLS_EBASE-13

CTOOLS dsptrace setclk error

#define CTOOLS_DSPTRACE_TEND_ERROR   CTOOLS_EBASE-47

CTOOLS dsptrace Trace END (TEND) error

#define CTOOLS_EBASE   (-128)

CTOOLS Error Base

#define CTOOLS_ETB_CLOSE_ERROR   CTOOLS_EBASE-10

CTOOLS etb close error

#define CTOOLS_ETB_DISABLE_ERROR   CTOOLS_EBASE-9

CTOOLS etb disable error

#define CTOOLS_ETB_EDMA_DRAIN_NOT_SUPPORTED   CTOOLS_EBASE-45

CTOOLS EDMA ETB extension not supported

#define CTOOLS_ETB_ENABLE_ERROR   CTOOLS_EBASE-4

CTOOLS etb enable error

#define CTOOLS_ETB_FLUSH_ERROR   CTOOLS_EBASE-5

CTOOLS etb flush error

#define CTOOLS_ETB_FLUSHDMA_ERROR   CTOOLS_EBASE-6

CTOOLS etb flush dma error

#define CTOOLS_ETB_GEN_ERROR   CTOOLS_EBASE-11

CTOOLS etb general error

#define CTOOLS_ETB_GETSTATUS_ERROR   CTOOLS_EBASE-7

CTOOLS etb get status error

#define CTOOLS_ETB_OPEN_ERROR   CTOOLS_EBASE-3

CTOOLS etb open error

#define CTOOLS_ETB_READ_ERROR   CTOOLS_EBASE-8

CTOOLS etb read error

#define CTOOLS_ETB_SIZE   4096
CTOOLS_ETB_SIZE
Size of the Core ETB is 4K Bytes
#define CTOOLS_FILEOPERATION_ERR   CTOOLS_EBASE-25

CTOOLS file operations error

#define CTOOLS_INVALID_CALL_SEQ   CTOOLS_EBASE-26

CTOOLS invalid call sequence triggered

#define CTOOLS_INVALID_PARAM   CTOOLS_EBASE-1

CTOOLS invalid parameter

#define CTOOLS_MIN_DATA_SIZE   CTOOLS_ETB_SIZE
CTOOLS_MIN_DATA_SIZE
Size of the CTOOLS_MIN_DATA_SIZE is 4K Bytes
#define CTOOLS_NOBUF_FOR_ETBDRAIN   CTOOLS_EBASE-22

CTOOLS no buffer for ETB error

#define CTOOLS_NOT_INITIALIZED   CTOOLS_EBASE-2

CTOOLS not initialized

#define CTOOLS_RESOURCE_BUSY   CTOOLS_EBASE-24

CTOOLS already running

#define CTOOLS_SOK   0

CTOOLS Low level Driver return and Error Codes CTOOLS successful return code

#define CTOOLS_SYSETB_NOT_ENABLED   CTOOLS_EBASE-43

CTOOLS System ETB not enabled

#define CTOOLS_SYSETB_STOPBUF_NOT_SUPPORTED   CTOOLS_EBASE-46

CTOOLS System ETB Stop on Full mode not supported

#define CTOOLS_SYSTEMTRACE_ENABLE_ERROR   CTOOLS_EBASE-42

CTOOLS System trace enable error

#define CTOOLS_UNSUPPORTED   CTOOLS_EBASE-23

CTOOLS unsupported features