src/modbus/modbus_serial_rtu.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Aurelien Jacobs <aurel@gnuage.org>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include <glib.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <libsigrok/libsigrok.h>
  25 #include "libsigrok-internal.h"
  26
  27 #define LOG_PREFIX "modbus_serial"
  28
  29 #ifdef HAVE_SERIAL_COMM
  30
  31 #define BUFFER_SIZE 1024
  32
  33 struct modbus_serial_rtu {
  34         struct sr_serial_dev_inst *serial;
  35         uint8_t slave_addr;
  36         uint16_t crc;
  37 };
  38
  39 static int modbus_serial_rtu_dev_inst_new(void *priv, const char *resource,
  40                 char **params, const char *serialcomm, int modbusaddr)
  41 {
  42         struct modbus_serial_rtu *modbus = priv;
  43
  44         (void)params;
  45
  46         modbus->serial = sr_serial_dev_inst_new(resource, serialcomm);
  47         modbus->slave_addr = modbusaddr;
  48
  49         return SR_OK;
  50 }
  51
  52 static int modbus_serial_rtu_open(void *priv)
  53 {
  54         struct modbus_serial_rtu *modbus = priv;
  55         struct sr_serial_dev_inst *serial = modbus->serial;
  56
  57         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  58                 return SR_ERR;
  59
  60         if (serial_flush(serial) != SR_OK)
  61                 return SR_ERR;
  62
  63         return SR_OK;
  64 }
  65
  66 static int modbus_serial_rtu_source_add(struct sr_session *session, void *priv,
  67                 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
  68 {
  69         struct modbus_serial_rtu *modbus = priv;
  70         struct sr_serial_dev_inst *serial = modbus->serial;
  71
  72         return serial_source_add(session, serial, events, timeout, cb, cb_data);
  73 }
  74
  75 static int modbus_serial_rtu_source_remove(struct sr_session *session,
  76                 void *priv)
  77 {
  78         struct modbus_serial_rtu *modbus = priv;
  79         struct sr_serial_dev_inst *serial = modbus->serial;
  80
  81         return serial_source_remove(session, serial);
  82 }
  83
  84 static int modbus_serial_rtu_send(void *priv,
  85                 const uint8_t *buffer, int buffer_size)
  86 {
  87         int result;
  88         struct modbus_serial_rtu *modbus = priv;
  89         struct sr_serial_dev_inst *serial = modbus->serial;
  90         uint8_t slave_addr = modbus->slave_addr;
  91         uint16_t crc;
  92
  93         result = serial_write_blocking(serial, &slave_addr, sizeof(slave_addr), 0);
  94         if (result < 0)
  95                 return SR_ERR;
  96
  97         result = serial_write_blocking(serial, buffer, buffer_size, 0);
  98         if (result < 0)
  99                 return SR_ERR;
 100
 101         crc = sr_crc16(SR_CRC16_DEFAULT_INIT, &slave_addr, sizeof(slave_addr));
 102         crc = sr_crc16(crc, buffer, buffer_size);
 103
 104         result = serial_write_blocking(serial, &crc, sizeof(crc), 0);
 105         if (result < 0)
 106                 return SR_ERR;
 107
 108         return SR_OK;
 109 }
 110
 111 static int modbus_serial_rtu_read_begin(void *priv, uint8_t *function_code)
 112 {
 113         struct modbus_serial_rtu *modbus = priv;
 114         uint8_t slave_addr;
 115         int ret;
 116
 117         ret = serial_read_blocking(modbus->serial, &slave_addr, 1, 500);
 118         if (ret != 1 || slave_addr != modbus->slave_addr)
 119                 return SR_ERR;
 120
 121         ret = serial_read_blocking(modbus->serial, function_code, 1, 100);
 122         if (ret != 1)
 123                 return SR_ERR;
 124
 125         modbus->crc = sr_crc16(SR_CRC16_DEFAULT_INIT, &slave_addr, sizeof(slave_addr));
 126         modbus->crc = sr_crc16(modbus->crc, function_code, 1);
 127
 128         return SR_OK;
 129 }
 130
 131 static int modbus_serial_rtu_read_data(void *priv, uint8_t *buf, int maxlen)
 132 {
 133         struct modbus_serial_rtu *modbus = priv;
 134         int ret;
 135
 136         ret = serial_read_nonblocking(modbus->serial, buf, maxlen);
 137         if (ret < 0)
 138                 return ret;
 139         modbus->crc = sr_crc16(modbus->crc, buf, ret);
 140         return ret;
 141 }
 142
 143 static int modbus_serial_rtu_read_end(void *priv)
 144 {
 145         struct modbus_serial_rtu *modbus = priv;
 146         uint16_t crc;
 147         int ret;
 148
 149         ret = serial_read_blocking(modbus->serial, &crc, sizeof(crc), 100);
 150         if (ret != 2)
 151                 return SR_ERR;
 152
 153         if (crc != modbus->crc) {
 154                 sr_err("CRC error (0x%04X vs 0x%04X).", crc, modbus->crc);
 155                 return SR_ERR_DATA;
 156         }
 157
 158         return SR_OK;
 159 }
 160
 161 static int modbus_serial_rtu_close(void *priv)
 162 {
 163         struct modbus_serial_rtu *modbus = priv;
 164
 165         return serial_close(modbus->serial);
 166 }
 167
 168 static void modbus_serial_rtu_free(void *priv)
 169 {
 170         struct modbus_serial_rtu *modbus = priv;
 171
 172         sr_serial_dev_inst_free(modbus->serial);
 173 }
 174
 175 SR_PRIV const struct sr_modbus_dev_inst modbus_serial_rtu_dev = {
 176         .name          = "serial_rtu",
 177         .prefix        = "",
 178         .priv_size     = sizeof(struct modbus_serial_rtu),
 179         .scan          = NULL,
 180         .dev_inst_new  = modbus_serial_rtu_dev_inst_new,
 181         .open          = modbus_serial_rtu_open,
 182         .source_add    = modbus_serial_rtu_source_add,
 183         .source_remove = modbus_serial_rtu_source_remove,
 184         .send          = modbus_serial_rtu_send,
 185         .read_begin    = modbus_serial_rtu_read_begin,
 186         .read_data     = modbus_serial_rtu_read_data,
 187         .read_end      = modbus_serial_rtu_read_end,
 188         .close         = modbus_serial_rtu_close,
 189         .free          = modbus_serial_rtu_free,
 190 };
 191
 192 #endif