mbproto.h

00001 /* 
00002  * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
00003  * Copyright (c) 2006 Christian Walter <wolti@sil.at>
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  * 1. Redistributions of source code must retain the above copyright
00010  *    notice, this list of conditions and the following disclaimer.
00011  * 2. Redistributions in binary form must reproduce the above copyright
00012  *    notice, this list of conditions and the following disclaimer in the
00013  *    documentation and/or other materials provided with the distribution.
00014  * 3. The name of the author may not be used to endorse or promote products
00015  *    derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00019  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00020  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00022  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00023  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00024  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00025  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00026  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  *
00028  * File: $Id: mbproto.h,v 1.14 2006/12/07 22:10:34 wolti Exp $
00029  */
00030 
00031 #ifndef _MB_PROTO_H
00032 #define _MB_PROTO_H
00033 
00034 #ifdef __cplusplus
00035 PR_BEGIN_EXTERN_C
00036 #endif
00037 /* ----------------------- Defines ------------------------------------------*/
00038 #define MB_ADDRESS_BROADCAST    ( 0 )   /*! Modbus broadcast address. */
00039 #define MB_ADDRESS_MIN          ( 1 )   /*! Smallest possible slave address. */
00040 #define MB_ADDRESS_MAX          ( 247 ) /*! Biggest possible slave address. */
00041 #define MB_FUNC_NONE                          (  0 )
00042 #define MB_FUNC_READ_COILS                    (  1 )
00043 #define MB_FUNC_READ_DISCRETE_INPUTS          (  2 )
00044 #define MB_FUNC_WRITE_SINGLE_COIL             (  5 )
00045 #define MB_FUNC_WRITE_MULTIPLE_COILS          ( 15 )
00046 #define MB_FUNC_READ_HOLDING_REGISTER         (  3 )
00047 #define MB_FUNC_READ_INPUT_REGISTER           (  4 )
00048 #define MB_FUNC_WRITE_REGISTER                (  6 )
00049 #define MB_FUNC_WRITE_MULTIPLE_REGISTERS      ( 16 )
00050 #define MB_FUNC_READWRITE_MULTIPLE_REGISTERS  ( 23 )
00051 #define MB_FUNC_DIAG_READ_EXCEPTION           (  7 )
00052 #define MB_FUNC_DIAG_DIAGNOSTIC               (  8 )
00053 #define MB_FUNC_DIAG_GET_COM_EVENT_CNT        ( 11 )
00054 #define MB_FUNC_DIAG_GET_COM_EVENT_LOG        ( 12 )
00055 #define MB_FUNC_OTHER_REPORT_SLAVEID          ( 17 )
00056 #define MB_FUNC_ERROR                         ( 128 )
00057 /* ----------------------- Type definitions ---------------------------------*/
00058     typedef enum
00059 {
00060     MB_EX_NONE = 0x00,
00061     MB_EX_ILLEGAL_FUNCTION = 0x01,
00062     MB_EX_ILLEGAL_DATA_ADDRESS = 0x02,
00063     MB_EX_ILLEGAL_DATA_VALUE = 0x03,
00064     MB_EX_SLAVE_DEVICE_FAILURE = 0x04,
00065     MB_EX_ACKNOWLEDGE = 0x05,
00066     MB_EX_SLAVE_BUSY = 0x06,
00067     MB_EX_MEMORY_PARITY_ERROR = 0x08,
00068     MB_EX_GATEWAY_PATH_FAILED = 0x0A,
00069     MB_EX_GATEWAY_TGT_FAILED = 0x0B
00070 } eMBException;
00071 
00072 typedef         eMBException( *pxMBFunctionHandler ) ( UCHAR * pucFrame, USHORT * pusLength );
00073 
00074 typedef struct
00075 {
00076     UCHAR           ucFunctionCode;
00077     pxMBFunctionHandler pxHandler;
00078 } xMBFunctionHandler;
00079 
00080 #ifdef __cplusplus
00081 PR_END_EXTERN_C
00082 #endif
00083 #endif