/* 
 * Filename: $Id: hp.txt,v 1.3 2008/05/26 23:29:28 rfiler Exp $
 *
 * Name:  HP Package User Information
 * 
 * Purpose: The HP package implements the HIP encoding and decoding 
 *          of messages. It consists of code implementing the Tx path
 *          (hptx.c) and Rx path (hdrx.c), corresponding to sending to
 *          the modem and receiving from the modem, respectively. The
 *          package also provides some routines for allocating buffers
 *          from a pool especially for HIP packets. Special buffer ptr
 *          offset manipulation routines are provided to allow callers
 *          to fill in the payload portion of the buffer directly to 
 *          prevent the need for copying multiple times
 *          
 * Entry Points:
 *          The HP package provides the following global entry points:
 *             hpTxPacket()   - See hptx.c for details
 *          
 *          Packet Reception
 *             hpregisterhip  - See hprx.c for details
 *             hpRxPacket()   - See hprx.c for details
 *             hpdumphipstats - See hprx.c for details
 *             hpclearhipstats - See hprx.c for details
 *          
 *          Package initialization function
 *             hpinit()       - See hd.c for details
 *          
 *          Buffer allocation and manipulation
 *             hpgetbuf       - See hdtx.c for details
 *             hpgetpayp      - See hdtx.c for details
 *
 * Testing:
 *          To test this package, compile and link the images including
 *          hptest.c from the command line. Execute the target and review
 *          the output. A copy of the GOOD output from a test execution is
 *          included after the comment section of this file
 *          
 * Limitations:
 *          None
 *          
 *          
 * NOTE:    This package is currently hard-coded to send Tx frames to
 *          the HD package for framing and transmission. Likewise, the
 *          HD package hands newly received frames to the HIP package.
 *          This package depends upon other applications to register 
 *          to receive HIP messages. If a packet is received without 
 *          a registered application to pass it on to, it will be 
 *          released silently.
 *          
 */          

/* Good Test Output follows */
------------------------------------------
hptest: raw packet size 128 bytes
payload size: 262 bytes
HIP Echo Request Contents
01:   7e 00 80 03 00 7d 5d 7d
02:   5d 7d 5d 7d 5d 7d 5d 7d
03:   5d 7d 5d 7d 5d 7d 5d 7d
04:   5d 7d 5d 7d 5d 7d 5d 7d
05:   5d 7d 5d 7d 5d 7d 5d 7d
06:   5d 7d 5d 7d 5d 7d 5d 7d
07:   5d 7d 5d 7d 5d 7d 5d 7d
08:   5d 7d 5d 7d 5d 7d 5d 7d
09:   5d 7d 5d 7d 5d 7d 5d 7d
10:   5d 7d 5d 7d 5d 7d 5d 7d
11:   5d 7d 5d 7d 5d 7d 5d 7d
12:   5d 7d 5d 7d 5d 7d 5d 7d
13:   5d 7d 5d 7d 5d 7d 5d 7d
14:   5d 7d 5d 7d 5d 7d 5d 7d
15:   5d 7d 5d 7d 5d 7d 5d 7d
16:   5d 7d 5d 7d 5d 7d 5d 7d
17:   5d 7d 5d 7d 5d 7d 5d 7d
18:   5d 7d 5d 7d 5d 7d 5d 7d
19:   5d 7d 5d 7d 5d 7d 5d 7d
20:   5d 7d 5d 7d 5d 7d 5d 7d
21:   5d 7d 5d 7d 5d 7d 5d 7d
22:   5d 7d 5d 7d 5d 7d 5d 7d
23:   5d 7d 5d 7d 5d 7d 5d 7d
24:   5d 7d 5d 7d 5d 7d 5d 7d
25:   5d 7d 5d 7d 5d 7d 5d 7d
26:   5d 7d 5d 7d 5d 7d 5d 7d
27:   5d 7d 5d 7d 5d 7d 5d 7d
28:   5d 7d 5d 7d 5d 7d 5d 7d
29:   5d 7d 5d 7d 5d 7d 5d 7d
30:   5d 7d 5d 7d 5d 7d 5d 7d
31:   5d 7d 5d 7d 5d 7d 5d 7d
32:   5d 7d 5d 7d 5d 7d 5d 7d
33:   5d 7d 5d 7d 5d 7e

Registering callback for msgid 43
Rx'd msgid 43, msgparm 0, msglength 128
01:   7d 7d 7d 7d 7d 7d 7d 7d
02:   7d 7d 7d 7d 7d 7d 7d 7d
03:   7d 7d 7d 7d 7d 7d 7d 7d
04:   7d 7d 7d 7d 7d 7d 7d 7d
05:   7d 7d 7d 7d 7d 7d 7d 7d
06:   7d 7d 7d 7d 7d 7d 7d 7d
07:   7d 7d 7d 7d 7d 7d 7d 7d
08:   7d 7d 7d 7d 7d 7d 7d 7d
09:   7d 7d 7d 7d 7d 7d 7d 7d
10:   7d 7d 7d 7d 7d 7d 7d 7d
11:   7d 7d 7d 7d 7d 7d 7d 7d
12:   7d 7d 7d 7d 7d 7d 7d 7d
13:   7d 7d 7d 7d 7d 7d 7d 7d
14:   7d 7d 7d 7d 7d 7d 7d 7d
15:   7d 7d 7d 7d 7d 7d 7d 7d
16:   7d 7d 7d 7d 7d 7d 7d 7d

Done
------------------------------------------

As of May 20, 2008 the output is logged in /var/log/user.log
"tailf user.log" gives a monitoring capabilities for observing the logs.
Sample output:

May 21 18:04:44 CARMD-Linuxdev3 SWI SDK Process: HP_TX:Package 4, c test 
May 21 18:04:44 CARMD-Linuxdev3 SWI SDK Process: HP_TX:package 4, bufp = 135132564 
May 21 18:04:44 CARMD-Linuxdev3 SWI SDK Process: HP_TX: payloadp = 135132568 
May 21 18:04:44 CARMD-Linuxdev3 ~
May 21 18:04:44 CARMD-Linuxdev3 �^C
May 21 18:04:44 CARMD-Linuxdev3 }]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]}]~
May 21 18:04:44 CARMD-Linuxdev3 SWI SDK Process: HP_TX: Send the echo request hpTxPacket bufp = 135132564 

epasheva@CARMD-Linuxdev3:/var/log$ pwd
/var/log
epasheva@CARMD-Linuxdev3:/var/log$ tailf user.log

/*
 * $Log: hp.txt,v $
 * Revision 1.3  2008/05/26 23:29:28  rfiler
 * Fixed missing Id reference at the top of this file for CVS filename
 *
 * Revision 1.2  2008/05/23 04:33:55  epasheva
 * Implemented comments from code review; added pool to hprx task; removed from package hp.c; updated hp.mak accordingly.
 *
 * Revision 1.1  2008/04/14 23:53:50  rfiler
 * New package description file for the HP package
 *
 *
 */
