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         return SR_OK;
  61 }
  62
  63 static int modbus_serial_rtu_source_add(struct sr_session *session, void *priv,
  64                 int events, int timeout, sr_receive_data_callback cb, void *cb_data)
  65 {
  66         struct modbus_serial_rtu *modbus = priv;
  67         struct sr_serial_dev_inst *serial = modbus->serial;
  68
  69         return serial_source_add(session, serial, events, timeout, cb, cb_data);
  70 }
  71
  72 static int modbus_serial_rtu_source_remove(struct sr_session *session,
  73                 void *priv)
  74 {
  75         struct modbus_serial_rtu *modbus = priv;
  76         struct sr_serial_dev_inst *serial = modbus->serial;
  77
  78         return serial_source_remove(session, serial);
  79 }
  80
  81 static int modbus_serial_rtu_send(void *priv,
  82                 const uint8_t *buffer, int buffer_size)
  83 {
  84         int result;
  85         struct modbus_serial_rtu *modbus = priv;
  86         struct sr_serial_dev_inst *serial = modbus->serial;
  87         uint8_t slave_addr = modbus->slave_addr;
  88         uint16_t crc;
  89
  90         result = serial_write_blocking(serial, &slave_addr, sizeof(slave_addr), 0);
  91         if (result < 0)
  92                 return SR_ERR;
  93
  94         result = serial_write_blocking(serial, buffer, buffer_size, 0);
  95         if (result < 0)
  96                 return SR_ERR;
  97
  98         crc = sr_crc16(SR_CRC16_DEFAULT_INIT, &slave_addr, sizeof(slave_addr));
  99         crc = sr_crc16(crc, buffer, buffer_size);
 100
 101         result = serial_write_blocking(serial, &crc, sizeof(crc), 0);
 102         if (result < 0)
 103                 return SR_ERR;
 104
 105         return SR_OK;
 106 }
 107
 108 static int modbus_serial_rtu_read_begin(void *priv, uint8_t *function_code)
 109 {
 110         struct modbus_serial_rtu *modbus = priv;
 111         uint8_t slave_addr;
 112         int ret;
 113
 114         ret = serial_read_blocking(modbus->serial, &slave_addr, 1, 500);
 115         if (ret != 1 || slave_addr != modbus->slave_addr)
 116                 return SR_ERR;
 117
 118         ret = serial_read_blocking(modbus->serial, function_code, 1, 100);
 119         if (ret != 1)
 120                 return SR_ERR;
 121
 122         modbus->crc = sr_crc16(SR_CRC16_DEFAULT_INIT, &slave_addr, sizeof(slave_addr));
 123         modbus->crc = sr_crc16(modbus->crc, function_code, 1);
 124
 125         return SR_OK;
 126 }
 127
 128 static int modbus_serial_rtu_read_data(void *priv, uint8_t *buf, int maxlen)
 129 {
 130         struct modbus_serial_rtu *modbus = priv;
 131         int ret;
 132
 133         ret = serial_read_nonblocking(modbus->serial, buf, maxlen);
 134         if (ret < 0)
 135                 return ret;
 136         modbus->crc = sr_crc16(modbus->crc, buf, ret);
 137         return ret;
 138 }
 139
 140 static int modbus_serial_rtu_read_end(void *priv)
 141 {
 142         struct modbus_serial_rtu *modbus = priv;
 143         uint16_t crc;
 144         int ret;
 145
 146         ret = serial_read_blocking(modbus->serial, &crc, sizeof(crc), 100);
 147         if (ret != 2)
 148                 return SR_ERR;
 149
 150         if (crc != modbus->crc) {
 151                 sr_err("CRC error (0x%04X vs 0x%04X).", crc, modbus->crc);
 152                 return SR_ERR_DATA;
 153         }
 154
 155         return SR_OK;
 156 }
 157
 158 static int modbus_serial_rtu_close(void *priv)
 159 {
 160         struct modbus_serial_rtu *modbus = priv;
 161
 162         return serial_close(modbus->serial);
 163 }
 164
 165 static void modbus_serial_rtu_free(void *priv)
 166 {
 167         struct modbus_serial_rtu *modbus = priv;
 168
 169         sr_serial_dev_inst_free(modbus->serial);
 170 }
 171
 172 SR_PRIV const struct sr_modbus_dev_inst modbus_serial_rtu_dev = {
 173         .name          = "serial_rtu",
 174         .prefix        = "",
 175         .priv_size     = sizeof(struct modbus_serial_rtu),
 176         .scan          = NULL,
 177         .dev_inst_new  = modbus_serial_rtu_dev_inst_new,
 178         .open          = modbus_serial_rtu_open,
 179         .source_add    = modbus_serial_rtu_source_add,
 180         .source_remove = modbus_serial_rtu_source_remove,
 181         .send          = modbus_serial_rtu_send,
 182         .read_begin    = modbus_serial_rtu_read_begin,
 183         .read_data     = modbus_serial_rtu_read_data,
 184         .read_end      = modbus_serial_rtu_read_end,
 185         .close         = modbus_serial_rtu_close,
 186         .free          = modbus_serial_rtu_free,
 187 };
 188
 189 #endif