common.h

Go to the documentation of this file.

/************************************************************************************************/
/*! \file common.h
*  \brief Communicate with serial device.
*  \author $Author: jayhawk_hokie $
*  \version $Revision: 1.4 $
*  \date    $Date: 2007/08/02 23:18:28 $
************************************************************************************************/
/*!
*
************************************************************************************************/

#ifndef _COMMON_H_
#define _COMMON_H_
#define CRC_16  0xa001          /* CRC-16 polynomial (used by modbus) */
#define CRC_CCITT 0x8408        /* CCITT polynomial */
typedef __uint8_t uint8;
typedef __uint16_t uint16;

/************************************************************************
 * Function: mbcrc_calc, mbcrc_tlu
 * Parameters: data - pointer to array of unsigned *8 bit characters.
 *             len - length of data array
 * Purpose:  These function will calculate or lookup the 16 bit CRC
 *           value of a character array.  Numerical CRC caluclation
 *           requires more processing time than table lookup.
 * Types:    uint8 is an 8 bit unsigned integer type.  Usually uint8
 *                  is realized with 'unsigned char'.
 *           uint16 is a 16 bit unisgned integer type.  Usually uint16
 *                  is realized with 'unsigned short'.
 ************************************************************************/

uint16 mbcrc_calc(uint8 *data, int len);
uint16 mbcwc_tlu(uint8 *data, int len);

/* Table of CRC values for high-order byte */
/*
static unsigned char au8CRCHi[] = {
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40,
0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1,
0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41,
0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0,
0x80, 0x41, 0x00, 0xC1, 0x81, 0x40
} ;
*/
/* Table of CRC values for low-order byte */
/*
static unsigned char au8CRCLo[] = {
0x00, 0xC0, 0xC1, 0x01, 0xC3, 0x03, 0x02, 0xC2, 0xC6, 0x06,
0x07, 0xC7, 0x05, 0xC5, 0xC4, 0x04, 0xCC, 0x0C, 0x0D, 0xCD,
0x0F, 0xCF, 0xCE, 0x0E, 0x0A, 0xCA, 0xCB, 0x0B, 0xC9, 0x09,
0x08, 0xC8, 0xD8, 0x18, 0x19, 0xD9, 0x1B, 0xDB, 0xDA, 0x1A,
0x1E, 0xDE, 0xDF, 0x1F, 0xDD, 0x1D, 0x1C, 0xDC, 0x14, 0xD4,
0xD5, 0x15, 0xD7, 0x17, 0x16, 0xD6, 0xD2, 0x12, 0x13, 0xD3,
0x11, 0xD1, 0xD0, 0x10, 0xF0, 0x30, 0x31, 0xF1, 0x33, 0xF3,
0xF2, 0x32, 0x36, 0xF6, 0xF7, 0x37, 0xF5, 0x35, 0x34, 0xF4,
0x3C, 0xFC, 0xFD, 0x3D, 0xFF, 0x3F, 0x3E, 0xFE, 0xFA, 0x3A,
0x3B, 0xFB, 0x39, 0xF9, 0xF8, 0x38, 0x28, 0xE8, 0xE9, 0x29,
0xEB, 0x2B, 0x2A, 0xEA, 0xEE, 0x2E, 0x2F, 0xEF, 0x2D, 0xED,
0xEC, 0x2C, 0xE4, 0x24, 0x25, 0xE5, 0x27, 0xE7, 0xE6, 0x26,
0x22, 0xE2, 0xE3, 0x23, 0xE1, 0x21, 0x20, 0xE0, 0xA0, 0x60,
0x61, 0xA1, 0x63, 0xA3, 0xA2, 0x62, 0x66, 0xA6, 0xA7, 0x67,
0xA5, 0x65, 0x64, 0xA4, 0x6C, 0xAC, 0xAD, 0x6D, 0xAF, 0x6F,
0x6E, 0xAE, 0xAA, 0x6A, 0x6B, 0xAB, 0x69, 0xA9, 0xA8, 0x68,
0x78, 0xB8, 0xB9, 0x79, 0xBB, 0x7B, 0x7A, 0xBA, 0xBE, 0x7E,
0x7F, 0xBF, 0x7D, 0xBD, 0xBC, 0x7C, 0xB4, 0x74, 0x75, 0xB5,
0x77, 0xB7, 0xB6, 0x76, 0x72, 0xB2, 0xB3, 0x73, 0xB1, 0x71,
0x70, 0xB0, 0x50, 0x90, 0x91, 0x51, 0x93, 0x53, 0x52, 0x92,
0x96, 0x56, 0x57, 0x97, 0x55, 0x95, 0x94, 0x54, 0x9C, 0x5C,
0x5D, 0x9D, 0x5F, 0x9F, 0x9E, 0x5E, 0x5A, 0x9A, 0x9B, 0x5B,
0x99, 0x59, 0x58, 0x98, 0x88, 0x48, 0x49, 0x89, 0x4B, 0x8B,
0x8A, 0x4A, 0x4E, 0x8E, 0x8F, 0x4F, 0x8D, 0x4D, 0x4C, 0x8C,
0x44, 0x84, 0x85, 0x45, 0x87, 0x47, 0x46, 0x86, 0x82, 0x42,
0x43, 0x83, 0x41, 0x81, 0x80, 0x40
} ;
*/


/**********************************************************************
 * Function: init_serial()
 * Description: Configure, open and initialize the serial port
 * Arguments:
 *        portfn -     - Port filename
 *         brate -     - baudrate
 *        portfd - out - file descriptor returned by open()
 * Return Values:
 *    0 - OK
 *   -1 - open() failed
 * Bugs: none known
 * Notes: Stable through several program revisions.
 * Last Update: 6/15/02
 * Last Updated By: Cengiz Akinli
 **********************************************************************/

int init_serial(char *portfn, speed_t brate, int *portfd);




/**********************************************************************
 * Function: say()
 * Description: Perform blocked, looped, write to a file
 * Arguments:
 *            fd - target file descriptor
 *           str - string to write
 * Return Values:
 *    0 - OK
 * Bugs: Vulnerable to signal interruption of read loop.  See code comment.
 * Notes: Does dumb writing only.  Checks bytes successfully written,
 *        but does not loop to write the remainder.  Such a loop, when it
 *        is added to this software, should go here.
 * Last Update: 7/1/02
 * Last Updated By: Cengiz Akinli
 **********************************************************************/

int say(int fd, char *str);




/**********************************************************************
 * Function: hear()
 * Description: Read data from the given fd into str with various parameters.
 *      Reads up to maxlen bytes.  Blocks for no more than maxbtime*3 usecs
 *      until either minlen bytes are read (if minlen is non-zero) or the
 *      term character is read in (which is included in the output string).
 * Arguments:
 *            fd -     - source file descriptor
 *           str - out - pre-allocated string buffer in which results
 *                      will be stored
 *        maxlen -     - Maxmimum number of bytes to read (must be <= number
 *                      of bytes allocated for str)
 *        minlen -     -  0 - No minumum input byte counting
 *                       >0 - Minumum number of bytes to read (see desc.)
 *      maxbtime -     - Max blocking time per select() in usec (see desc)
 *          term -     - Terminator character to mark end of input
 *
 * Return Values:
 *    0 - OK
 *    1 - Read 0 bytes
 * Bugs:  Vulnerable to signal interruption of write loop.  See code comment.
 * Notes: Use of minlen is deprecated vs term character selection.  In either
 *      case, blocking time is still limited to 3*maxbtime usec.
 * Last Update: 7/1/02
 * Last Updated By: Cengiz Akinli
 **********************************************************************/

int hear(int fd, char *str, int maxlen, int minlen, int maxbtime, char term);



#endif

/* Do not change the comments below - they will be added automatically by CVS*/
/*****************************************************************************
*       $Log: common.h,v $
*       Revision 1.4  2007/08/02 23:18:28  jayhawk_hokie
*       Fixed Warnings.
*
*
*
******************************************************************************/

---