source: cmedia/trunk/Drv16/log.hpp

/* SCCSID = src/dev/mme/tropez/log.hpp, tropez, c.basedd 97/07/17 */
/****************************************************************************
 *                                                                          *
 * Copyright (c) IBM Corporation 1994 - 1997.                               *
 *                                                                          *
 * The following IBM OS/2 source code is provided to you solely for the     *
 * the purpose of assisting you in your development of OS/2 device drivers. *
 * You may use this code in accordance with the IBM License Agreement       *
 * provided in the IBM Device Driver Source Kit for OS/2.                   *
 *                                                                          *
 ****************************************************************************/
/**@internal src/dev/mme/tropez/log.hpp, tropez, c.basedd
 *  LOG, BINARYLOG, PERFLOG definitions.
 * @version 1.6
 * @context
 *  Unless otherwise noted, all interfaces are Ring-0, 16-bit, kernel stack.
 * @notes
 *  ### More is coming in this area.
 * @history
 */

#ifndef LOG_INCLUDED
#define LOG_INCLUDED

#ifdef __cplusplus
extern "C" {
#endif
#ifndef OS2_INCLUDED
#define INCL_NOPMAPI
#define INCL_DOSMISC
#include <os2.h>
#endif // OS2_INCLUDED
#ifdef __cplusplus
}
#endif

typedef unsigned short WORD;
typedef unsigned long DWORD;

// This structure is used to walk the parameters on the stack.
typedef union {
      void  far *VoidPtr;
      BYTE  far *BytePtr;
      WORD  far *WordPtr;
      DWORD far *LongPtr;
      DWORD far *StringPtr;     //### Why did this break when made
                                //### into a 'char far *?
} STACK_ADR, FAR *PSTACK_ADR;


// Maximum length of a message.
const int MAX_MsgLen = 255;

// Enumerate the places where logging messages can be saved.
enum _MessageSink { _Display, _SerialLine, _ErrorLog, _TraceLog };
const int _nMsgSinks = _TraceLog + 1;

class LOG {
public:
   //--- Data.

   // This vector indicates whether or not the messages should be streamed
   // to a particular message sink.  Initialized to all TRUE.
   BOOL bMsgSink[_nMsgSinks];

   //--- Public methods.

   // Create a log.
   LOG( USHORT DosTraceLogMajor, PSZ* apszMsgText );

   // Log an event without data.
   virtual void vTrace( USHORT errNum );

   // Log an event with data.
   virtual void vLog( USHORT errNum, ... );

protected:

   //--- Private and protected data.

   // This is the major code (must be in range of 240 to 255) under which
   // messages will be saved in the System Trace log.  Messages can be retrieved
   // using the OS/2 TRACEFMT utility.
   const USHORT _DosTraceMajorCode;

   // This vbls is a pointer to an array of NLV messages.  An array of messages
   // is assoicated with this LOG object when the object is created.
   PSZ* _apszMsgText;

   // Private scratch area.  We build up the log entries in this string.
   UCHAR _dd_BuildString[ MAX_MsgLen ];

private:

   // Keep track of whether we're executing at Ring3 or 0.
   BOOL _bInRing3;

   // Comm port (COM1: or COM2:) to send messages out of (used only if
   // the Serial line is selected as a message sink.
   USHORT _ComPort;

   //--- Private member functions

   // Binary to Ascii conversion routines.
   PSZ _DecWordToASCII( PSZ StrPtr, WORD wDecVal, WORD Option );
   PSZ _DecLongToASCII( PSZ StrPtr, DWORD lDecVal,WORD Option );
   PSZ _HexWordToASCII( PSZ StrPtr, WORD wHexVal, WORD Option );
   PSZ _HexLongToASCII( PSZ StrPtr, DWORD wHexVal, WORD Option );

   // Send a character out the COM port.
   void _CharOut( char );

   // Save the message in one or more destinations.
   void _ddputstring ( USHORT iMsgNum, PSZ St);

   // Formatting routine - converts binary->ASCII & merges with PII.
   USHORT _ddsprintf ( PSZ pszOutString, PSZ pszFmtString, STACK_ADR Parm );

}; // class LOG


class BINARYLOG : public LOG {
public:

   // Create a log.
   BINARYLOG( USHORT DosTraceLogMajor, PSZ* apszMsgText );

   // Log a trace point.
   virtual void vTrace( USHORT eventNum );

   // Log an event with data.
   virtual void vLog( USHORT eventNum, ... );

private:

   // Formatting routine - converts binary->ASCII & merges with PII.
   USHORT _ddsprintf ( PSZ pszOutString, PSZ pszFmtString, STACK_ADR Parm );

}; // class BINARYLOG


class PERFLOG : public LOG {
public:

   // Create a log.
   PERFLOG( USHORT DosTraceLogMajor, PSZ* apszMsgText );

   // Record current RDTSC cycle count (from Intel processor) into system Trace log.
   virtual void vTrace( USHORT eventNum );

}; // class PERFLOG


extern LOG* pStatus;                    // Status log.
extern LOG* pError;                     // Error log.
extern LOG* pSoftError;                 // Error log.
extern BINARYLOG* pTrace;               // Trace log.
extern PERFLOG* pPerfLog;               // Performance trace log.

#endif  // LOG_INCLUDED