Project

General

Profile

Statistics
| Branch: | Revision:

root / freemodbus / modbus / include / mbproto.h @ 20e5429c

History | View | Annotate | Download (3.59 KB)

1 20e5429c Tom Mullins
/* 
2
 * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
3
 * Copyright (c) 2006 Christian Walter <wolti@sil.at>
4
 * All rights reserved.
5
 *
6
 * Redistribution and use in source and binary forms, with or without
7
 * modification, are permitted provided that the following conditions
8
 * are met:
9
 * 1. Redistributions of source code must retain the above copyright
10
 *    notice, this list of conditions and the following disclaimer.
11
 * 2. Redistributions in binary form must reproduce the above copyright
12
 *    notice, this list of conditions and the following disclaimer in the
13
 *    documentation and/or other materials provided with the distribution.
14
 * 3. The name of the author may not be used to endorse or promote products
15
 *    derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 *
28
 * File: $Id: mbproto.h,v 1.14 2006/12/07 22:10:34 wolti Exp $
29
 */
30
31
#ifndef _MB_PROTO_H
32
#define _MB_PROTO_H
33
34
#ifdef __cplusplus
35
PR_BEGIN_EXTERN_C
36
#endif
37
/* ----------------------- Defines ------------------------------------------*/
38
#define MB_ADDRESS_BROADCAST    ( 0 )   /*! Modbus broadcast address. */
39
#define MB_ADDRESS_MIN          ( 1 )   /*! Smallest possible slave address. */
40
#define MB_ADDRESS_MAX          ( 247 ) /*! Biggest possible slave address. */
41
#define MB_FUNC_NONE                          (  0 )
42
#define MB_FUNC_READ_COILS                    (  1 )
43
#define MB_FUNC_READ_DISCRETE_INPUTS          (  2 )
44
#define MB_FUNC_WRITE_SINGLE_COIL             (  5 )
45
#define MB_FUNC_WRITE_MULTIPLE_COILS          ( 15 )
46
#define MB_FUNC_READ_HOLDING_REGISTER         (  3 )
47
#define MB_FUNC_READ_INPUT_REGISTER           (  4 )
48
#define MB_FUNC_WRITE_REGISTER                (  6 )
49
#define MB_FUNC_WRITE_MULTIPLE_REGISTERS      ( 16 )
50
#define MB_FUNC_READWRITE_MULTIPLE_REGISTERS  ( 23 )
51
#define MB_FUNC_DIAG_READ_EXCEPTION           (  7 )
52
#define MB_FUNC_DIAG_DIAGNOSTIC               (  8 )
53
#define MB_FUNC_DIAG_GET_COM_EVENT_CNT        ( 11 )
54
#define MB_FUNC_DIAG_GET_COM_EVENT_LOG        ( 12 )
55
#define MB_FUNC_OTHER_REPORT_SLAVEID          ( 17 )
56
#define MB_FUNC_ERROR                         ( 128 )
57
/* ----------------------- Type definitions ---------------------------------*/
58
    typedef enum
59
{
60
    MB_EX_NONE = 0x00,
61
    MB_EX_ILLEGAL_FUNCTION = 0x01,
62
    MB_EX_ILLEGAL_DATA_ADDRESS = 0x02,
63
    MB_EX_ILLEGAL_DATA_VALUE = 0x03,
64
    MB_EX_SLAVE_DEVICE_FAILURE = 0x04,
65
    MB_EX_ACKNOWLEDGE = 0x05,
66
    MB_EX_SLAVE_BUSY = 0x06,
67
    MB_EX_MEMORY_PARITY_ERROR = 0x08,
68
    MB_EX_GATEWAY_PATH_FAILED = 0x0A,
69
    MB_EX_GATEWAY_TGT_FAILED = 0x0B
70
} eMBException;
71
72
typedef         eMBException( *pxMBFunctionHandler ) ( UCHAR * pucFrame, USHORT * pusLength );
73
74
typedef struct
75
{
76
    UCHAR           ucFunctionCode;
77
    pxMBFunctionHandler pxHandler;
78
} xMBFunctionHandler;
79
80
#ifdef __cplusplus
81
PR_END_EXTERN_C
82
#endif
83
#endif