85 lines
4.5 KiB
HTML
85 lines
4.5 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="reference" />
|
||
|
|
<meta name="DC.Title" content="cwbSV_LogSPIEntry" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksvcapilist3.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="cwbsv_logspientry" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>cwbSV_LogSPIEntry</title>
|
||
|
|
</head>
|
||
|
|
<body id="cwbsv_logspientry"><a name="cwbsv_logspientry"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">cwbSV_LogSPIEntry</h1>
|
||
|
|
<div><div class="section"><h4 class="sectiontitle">Purpose</h4>
|
||
|
|
<p>This function will log an SPI entry point to the currently active entry/exit
|
||
|
|
trace file. The product and component ID's set in the entry will be written
|
||
|
|
along with the date and time of the when the data was logged. The spiID, along
|
||
|
|
with any optional data that is passed on the request, will also be logged.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4>
|
||
|
|
<pre>
|
||
|
|
unsigned int CWB_ENTRY cwbSV_LogSPIEntry(
|
||
|
|
cwbSV_TraceSPIHandle traceSPIHandle,
|
||
|
|
unsigned char spiID,
|
||
|
|
char *spiData,
|
||
|
|
unsigned long spiDataLength);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameters</h4>
|
||
|
|
<dl><dt class="dlterm">cwbSV_TraceSPIHandle traceSPIHandle - input</dt>
|
||
|
|
<dd>Handle that was returned by a previous call to cwbSV_CreateTraceSPIHandle().</dd>
|
||
|
|
<dt class="dlterm">unsigned char spiID - input</dt>
|
||
|
|
<dd>A unique one-byte code that will distinguish this SPI trace point from
|
||
|
|
others that are logged by your program. Definition of these codes are left
|
||
|
|
up to the caller of this API. The recommended approach is to use the defined
|
||
|
|
range (0x00 - 0xFF) for each unique component in your product (that is, start
|
||
|
|
at 0x00 for each component)</dd>
|
||
|
|
<dt class="dlterm">char * spiData - input</dt>
|
||
|
|
<dd>Points to a buffer that contains additional data (for example, input
|
||
|
|
parameter values from your caller) that you want to log along with this entry
|
||
|
|
point. Parameter is optional, it is ignored if the address is NULL or the
|
||
|
|
data length is zero. This buffer can contain binary data because the length
|
||
|
|
parameter is used in determining the amount to trace.</dd>
|
||
|
|
<dt class="dlterm">unsigned long spiDataLength - input</dt>
|
||
|
|
<dd>Specifies the number of bytes in the SPI data buffer to log for this
|
||
|
|
trace entry.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Return Codes</h4>
|
||
|
|
<p>The following list shows common return values.</p>
|
||
|
|
|
||
|
|
<dl><dt class="dlterm">CWB_OK</dt>
|
||
|
|
<dd>Successful completion.</dd>
|
||
|
|
<dt class="dlterm">CWB_INVALID_HANDLE</dt>
|
||
|
|
<dd>IHandle is not valid.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4>
|
||
|
|
<p>This call should allows be used in conjunction with a corresponding "cwbSV_LogSPIExit()".
|
||
|
|
It is recommended that these calls would be put at the beginning and end of
|
||
|
|
an API routine that you write. The other method would be to use these log
|
||
|
|
functions around calls to external routines that are not written by you.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksvcapilist3.htm" title="Use these APIs to write trace points to an entry/exit trace file">Serviceability API list: Writing trace points</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|