Jason Engelman
/
Modbus
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
mbframe.h@0:7b5d37a81b6b, 2010-10-05 (annotated)
- Committer:
- tecnosys
- Date:
- Tue Oct 05 11:51:06 2010 +0000
- Revision:
- 0:7b5d37a81b6b
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| tecnosys | 0:7b5d37a81b6b | 1 | /* |
| tecnosys | 0:7b5d37a81b6b | 2 | * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU. |
| tecnosys | 0:7b5d37a81b6b | 3 | * Copyright (c) 2006 Christian Walter <wolti@sil.at> |
| tecnosys | 0:7b5d37a81b6b | 4 | * All rights reserved. |
| tecnosys | 0:7b5d37a81b6b | 5 | * |
| tecnosys | 0:7b5d37a81b6b | 6 | * Redistribution and use in source and binary forms, with or without |
| tecnosys | 0:7b5d37a81b6b | 7 | * modification, are permitted provided that the following conditions |
| tecnosys | 0:7b5d37a81b6b | 8 | * are met: |
| tecnosys | 0:7b5d37a81b6b | 9 | * 1. Redistributions of source code must retain the above copyright |
| tecnosys | 0:7b5d37a81b6b | 10 | * notice, this list of conditions and the following disclaimer. |
| tecnosys | 0:7b5d37a81b6b | 11 | * 2. Redistributions in binary form must reproduce the above copyright |
| tecnosys | 0:7b5d37a81b6b | 12 | * notice, this list of conditions and the following disclaimer in the |
| tecnosys | 0:7b5d37a81b6b | 13 | * documentation and/or other materials provided with the distribution. |
| tecnosys | 0:7b5d37a81b6b | 14 | * 3. The name of the author may not be used to endorse or promote products |
| tecnosys | 0:7b5d37a81b6b | 15 | * derived from this software without specific prior written permission. |
| tecnosys | 0:7b5d37a81b6b | 16 | * |
| tecnosys | 0:7b5d37a81b6b | 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| tecnosys | 0:7b5d37a81b6b | 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| tecnosys | 0:7b5d37a81b6b | 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| tecnosys | 0:7b5d37a81b6b | 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| tecnosys | 0:7b5d37a81b6b | 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| tecnosys | 0:7b5d37a81b6b | 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| tecnosys | 0:7b5d37a81b6b | 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| tecnosys | 0:7b5d37a81b6b | 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| tecnosys | 0:7b5d37a81b6b | 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| tecnosys | 0:7b5d37a81b6b | 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| tecnosys | 0:7b5d37a81b6b | 27 | * |
| tecnosys | 0:7b5d37a81b6b | 28 | * File: $Id: mbframe.h,v 1.9 2006/12/07 22:10:34 wolti Exp $ |
| tecnosys | 0:7b5d37a81b6b | 29 | */ |
| tecnosys | 0:7b5d37a81b6b | 30 | |
| tecnosys | 0:7b5d37a81b6b | 31 | #ifndef _MB_FRAME_H |
| tecnosys | 0:7b5d37a81b6b | 32 | #define _MB_FRAME_H |
| tecnosys | 0:7b5d37a81b6b | 33 | |
| tecnosys | 0:7b5d37a81b6b | 34 | #ifdef __cplusplus |
| tecnosys | 0:7b5d37a81b6b | 35 | PR_BEGIN_EXTERN_C |
| tecnosys | 0:7b5d37a81b6b | 36 | #endif |
| tecnosys | 0:7b5d37a81b6b | 37 | |
| tecnosys | 0:7b5d37a81b6b | 38 | /*! |
| tecnosys | 0:7b5d37a81b6b | 39 | * Constants which defines the format of a modbus frame. The example is |
| tecnosys | 0:7b5d37a81b6b | 40 | * shown for a Modbus RTU/ASCII frame. Note that the Modbus PDU is not |
| tecnosys | 0:7b5d37a81b6b | 41 | * dependent on the underlying transport. |
| tecnosys | 0:7b5d37a81b6b | 42 | * |
| tecnosys | 0:7b5d37a81b6b | 43 | * <code> |
| tecnosys | 0:7b5d37a81b6b | 44 | * <------------------------ MODBUS SERIAL LINE PDU (1) -------------------> |
| tecnosys | 0:7b5d37a81b6b | 45 | * <----------- MODBUS PDU (1') ----------------> |
| tecnosys | 0:7b5d37a81b6b | 46 | * +-----------+---------------+----------------------------+-------------+ |
| tecnosys | 0:7b5d37a81b6b | 47 | * | Address | Function Code | Data | CRC/LRC | |
| tecnosys | 0:7b5d37a81b6b | 48 | * +-----------+---------------+----------------------------+-------------+ |
| tecnosys | 0:7b5d37a81b6b | 49 | * | | | | |
| tecnosys | 0:7b5d37a81b6b | 50 | * (2) (3/2') (3') (4) |
| tecnosys | 0:7b5d37a81b6b | 51 | * |
| tecnosys | 0:7b5d37a81b6b | 52 | * (1) ... MB_SER_PDU_SIZE_MAX = 256 |
| tecnosys | 0:7b5d37a81b6b | 53 | * (2) ... MB_SER_PDU_ADDR_OFF = 0 |
| tecnosys | 0:7b5d37a81b6b | 54 | * (3) ... MB_SER_PDU_PDU_OFF = 1 |
| tecnosys | 0:7b5d37a81b6b | 55 | * (4) ... MB_SER_PDU_SIZE_CRC = 2 |
| tecnosys | 0:7b5d37a81b6b | 56 | * |
| tecnosys | 0:7b5d37a81b6b | 57 | * (1') ... MB_PDU_SIZE_MAX = 253 |
| tecnosys | 0:7b5d37a81b6b | 58 | * (2') ... MB_PDU_FUNC_OFF = 0 |
| tecnosys | 0:7b5d37a81b6b | 59 | * (3') ... MB_PDU_DATA_OFF = 1 |
| tecnosys | 0:7b5d37a81b6b | 60 | * </code> |
| tecnosys | 0:7b5d37a81b6b | 61 | */ |
| tecnosys | 0:7b5d37a81b6b | 62 | |
| tecnosys | 0:7b5d37a81b6b | 63 | /* ----------------------- Defines ------------------------------------------*/ |
| tecnosys | 0:7b5d37a81b6b | 64 | #define MB_PDU_SIZE_MAX 253 /*!< Maximum size of a PDU. */ |
| tecnosys | 0:7b5d37a81b6b | 65 | #define MB_PDU_SIZE_MIN 1 /*!< Function Code */ |
| tecnosys | 0:7b5d37a81b6b | 66 | #define MB_PDU_FUNC_OFF 0 /*!< Offset of function code in PDU. */ |
| tecnosys | 0:7b5d37a81b6b | 67 | #define MB_PDU_DATA_OFF 1 /*!< Offset for response data in PDU. */ |
| tecnosys | 0:7b5d37a81b6b | 68 | |
| tecnosys | 0:7b5d37a81b6b | 69 | /* ----------------------- Prototypes 0-------------------------------------*/ |
| tecnosys | 0:7b5d37a81b6b | 70 | typedef void ( *pvMBFrameStart ) ( void ); |
| tecnosys | 0:7b5d37a81b6b | 71 | |
| tecnosys | 0:7b5d37a81b6b | 72 | typedef void ( *pvMBFrameStop ) ( void ); |
| tecnosys | 0:7b5d37a81b6b | 73 | |
| tecnosys | 0:7b5d37a81b6b | 74 | typedef eMBErrorCode( *peMBFrameReceive ) ( UCHAR * pucRcvAddress, |
| tecnosys | 0:7b5d37a81b6b | 75 | UCHAR ** pucFrame, |
| tecnosys | 0:7b5d37a81b6b | 76 | USHORT * pusLength ); |
| tecnosys | 0:7b5d37a81b6b | 77 | |
| tecnosys | 0:7b5d37a81b6b | 78 | typedef eMBErrorCode( *peMBFrameSend ) ( UCHAR slaveAddress, |
| tecnosys | 0:7b5d37a81b6b | 79 | const UCHAR * pucFrame, |
| tecnosys | 0:7b5d37a81b6b | 80 | USHORT usLength ); |
| tecnosys | 0:7b5d37a81b6b | 81 | |
| tecnosys | 0:7b5d37a81b6b | 82 | typedef void( *pvMBFrameClose ) ( void ); |
| tecnosys | 0:7b5d37a81b6b | 83 | |
| tecnosys | 0:7b5d37a81b6b | 84 | #ifdef __cplusplus |
| tecnosys | 0:7b5d37a81b6b | 85 | PR_END_EXTERN_C |
| tecnosys | 0:7b5d37a81b6b | 86 | #endif |
| tecnosys | 0:7b5d37a81b6b | 87 | #endif |