espressif/esp-modbus
1
0
Fork 1
mirror of https://github.com/espressif/esp-modbus.git synced 2026-08-03 20:24:09 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1af46133faabd4bbc4177227b1f5b8c5c2066338
esp-modbus/modbus/mb_objects/functions/mbfunccoils_master.c
T
aleks 1af46133fa fix: master handling of broadcast request
2026-07-08 15:59:17 +02:00

363 lines
13 KiB
C
Raw Blame History

/*
* SPDX-FileCopyrightText: 2013 Armink
*
* SPDX-License-Identifier: BSD-3-Clause
*
* SPDX-FileContributor: 2020-2026 Espressif Systems (Shanghai) CO LTD
*/
/*
* FreeModbus Library: A portable Modbus implementation for Modbus ASCII/RTU.
* Copyright (C) 2013 Armink <armink.ztl@gmail.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* File: $Id: mbfunccoils_m.c, v 1.60 2013/10/12 15:10:12 Armink Add Master Functions
*/
#include "mb_common.h"
#include "mb_proto.h"
#include "transport_common.h"
#include "mb_master.h"
/* ----------------------- Defines ------------------------------------------*/
#define MB_PDU_REQ_READ_ADDR_OFF (MB_PDU_DATA_OFF + 0)
#define MB_PDU_REQ_READ_COILCNT_OFF (MB_PDU_DATA_OFF + 2)
#define MB_PDU_REQ_READ_SIZE (4)
#define MB_PDU_FUNC_READ_COILCNT_OFF (MB_PDU_DATA_OFF + 0)
#define MB_PDU_FUNC_READ_VALUES_OFF (MB_PDU_DATA_OFF + 1)
#define MB_PDU_FUNC_READ_SIZE_MIN (1)
#define MB_PDU_REQ_WRITE_ADDR_OFF (MB_PDU_DATA_OFF)
#define MB_PDU_REQ_WRITE_VALUE_OFF (MB_PDU_DATA_OFF + 2)
#define MB_PDU_REQ_WRITE_SIZE (4)
#define MB_PDU_FUNC_WRITE_ADDR_OFF (MB_PDU_DATA_OFF)
#define MB_PDU_FUNC_WRITE_VALUE_OFF (MB_PDU_DATA_OFF + 2)
#define MB_PDU_FUNC_WRITE_SIZE (4)
#define MB_PDU_REQ_WRITE_MUL_ADDR_OFF (MB_PDU_DATA_OFF)
#define MB_PDU_REQ_WRITE_MUL_COILCNT_OFF (MB_PDU_DATA_OFF + 2)
#define MB_PDU_REQ_WRITE_MUL_BYTECNT_OFF (MB_PDU_DATA_OFF + 4)
#define MB_PDU_REQ_WRITE_MUL_VALUES_OFF (MB_PDU_DATA_OFF + 5)
#define MB_PDU_REQ_WRITE_MUL_SIZE_MIN (5)
#define MB_PDU_REQ_WRITE_MUL_COILCNT_MAX (0x07B0)
#define MB_PDU_FUNC_WRITE_MUL_ADDR_OFF (MB_PDU_DATA_OFF)
#define MB_PDU_FUNC_WRITE_MUL_COILCNT_OFF (MB_PDU_DATA_OFF + 2)
#define MB_PDU_FUNC_WRITE_MUL_SIZE (5)
/* ----------------------- Static functions ---------------------------------*/
mb_exception_t mb_error_to_exception(mb_err_enum_t error_code);
/* ----------------------- Start implementation -----------------------------*/
#if MB_MASTER_RTU_ENABLED || MB_MASTER_ASCII_ENABLED || MB_MASTER_TCP_ENABLED
#if MB_FUNC_READ_COILS_ENABLED
/**
* This function will request read coil.
*
* @param snd_addr salve address
* @param coil_addr coil start address
* @param coil_num coil total number
* @param timeout timeout (-1 will waiting forever)
*
* @return error code
*/
mb_err_enum_t mbm_rq_read_coils(mb_base_t *inst, uint8_t snd_addr, uint16_t coil_addr, uint16_t coil_num, uint32_t tout)
{
uint8_t *mb_frame_ptr;
if (snd_addr > MB_ADDRESS_MAX) {
return MB_EINVAL;
}
/* The broadcast coils read request is not allowed. */
if (!snd_addr) {
return MB_ENOREG;
}
if (!mb_port_event_res_take(inst->port_obj, tout)) {
return MB_EBUSY;
}
inst->get_send_buf(inst, &mb_frame_ptr);
inst->set_dest_addr(inst, snd_addr);
mb_frame_ptr[MB_PDU_FUNC_OFF] = MB_FUNC_READ_COILS;
mb_frame_ptr[MB_PDU_REQ_READ_ADDR_OFF] = coil_addr >> 8;
mb_frame_ptr[MB_PDU_REQ_READ_ADDR_OFF + 1] = coil_addr;
mb_frame_ptr[MB_PDU_REQ_READ_COILCNT_OFF] = coil_num >> 8;
mb_frame_ptr[MB_PDU_REQ_READ_COILCNT_OFF + 1] = coil_num;
inst->set_send_len(inst, MB_PDU_SIZE_MIN + MB_PDU_REQ_READ_SIZE);
(void)mb_port_event_post(inst->port_obj, EVENT(EV_FRAME_TRANSMIT | EV_TRANS_START) );
return mb_port_event_wait_req_finish(inst->port_obj);
}
mb_exception_t mbm_fn_read_coils(mb_base_t *inst, uint8_t *frame_ptr, uint16_t *len_buf)
{
uint8_t byte_cnt;
uint8_t *mb_frame_ptr;
uint16_t reg_addr;
uint16_t coil_cnt;
mb_exception_t status = MB_EX_NONE;
mb_err_enum_t reg_status = MB_EILLFUNC;
if (!len_buf || !frame_ptr || !inst) {
return MB_EINVAL;
}
if (inst->transp_obj->frm_is_bcast(inst->transp_obj)) {
status = MB_EX_ILLEGAL_DATA_ADDRESS;
} else if (*len_buf >= MB_PDU_SIZE_MIN + MB_PDU_FUNC_READ_SIZE_MIN) {
inst->get_send_buf(inst, &mb_frame_ptr);
reg_addr = (uint16_t)(mb_frame_ptr[MB_PDU_REQ_READ_ADDR_OFF] << 8 );
reg_addr |= (uint16_t)(mb_frame_ptr[MB_PDU_REQ_READ_ADDR_OFF + 1] );
reg_addr++;
coil_cnt = (uint16_t)(mb_frame_ptr[MB_PDU_REQ_READ_COILCNT_OFF] << 8 );
coil_cnt |= (uint16_t)(mb_frame_ptr[MB_PDU_REQ_READ_COILCNT_OFF + 1] );
/* Test if the quantity of coils is a multiple of 8. If not last
* byte is only partially field with unused coils set to zero. */
if ((coil_cnt & 0x0007) != 0) {
byte_cnt = (uint8_t)(coil_cnt / 8 + 1);
} else {
byte_cnt = (uint8_t)(coil_cnt / 8);
}
/* Check if the number of registers to read is valid. If not
* return Modbus illegal data value exception.
*/
if ((coil_cnt >= 1) && (byte_cnt == frame_ptr[MB_PDU_FUNC_READ_COILCNT_OFF])) {
/* Make callback to fill the buffer. */
if (inst->rw_cbs.reg_coils_cb) {
reg_status = inst->rw_cbs.reg_coils_cb(inst, &frame_ptr[MB_PDU_FUNC_READ_VALUES_OFF], reg_addr, coil_cnt, MB_REG_READ);
}
/* If an error occurred convert it into a Modbus exception. */
if (reg_status != MB_ENOERR) {
status = mb_error_to_exception(reg_status);
}
} else {
status = MB_EX_ILLEGAL_DATA_VALUE;
}
} else {
/* Can't be a valid read coil register request because the length
* is incorrect. */
status = MB_EX_ILLEGAL_DATA_VALUE;
}
return status;
}
#endif
#if MB_FUNC_WRITE_COIL_ENABLED
/**
* This function will request write one coil.
*
* @param snd_addr salve address
* @param coil_addr coil start address
* @param coil_data data to be written
* @param timeout timeout (-1 will waiting forever)
*
* @return error code
*
* @see mbm_rq_write_multi_coils
*/
mb_err_enum_t mbm_rq_write_coil(mb_base_t *inst, uint8_t snd_addr, uint16_t coil_addr, uint16_t coil_data, uint32_t tout)
{
uint8_t *mb_frame_ptr;
if (!inst || (snd_addr > MB_ADDRESS_MAX)) {
return MB_EINVAL;
}
if ((coil_data != 0xFF00) && (coil_data != 0x0000)) {
return MB_EINVAL;
}
if (!mb_port_event_res_take(inst->port_obj, tout)) {
return MB_EBUSY;
}
inst->get_send_buf(inst, &mb_frame_ptr);
inst->set_dest_addr(inst, snd_addr);
mb_frame_ptr[MB_PDU_FUNC_OFF] = MB_FUNC_WRITE_SINGLE_COIL;
mb_frame_ptr[MB_PDU_REQ_WRITE_ADDR_OFF] = coil_addr >> 8;
mb_frame_ptr[MB_PDU_REQ_WRITE_ADDR_OFF + 1] = coil_addr;
mb_frame_ptr[MB_PDU_REQ_WRITE_VALUE_OFF] = coil_data >> 8;
mb_frame_ptr[MB_PDU_REQ_WRITE_VALUE_OFF + 1] = coil_data;
inst->set_send_len(inst, (MB_PDU_SIZE_MIN + MB_PDU_REQ_WRITE_SIZE));
(void)mb_port_event_post(inst->port_obj, EVENT(EV_FRAME_TRANSMIT | EV_TRANS_START) );
return mb_port_event_wait_req_finish(inst->port_obj);
}
mb_exception_t mbm_fn_write_coil(mb_base_t *inst, uint8_t *frame_ptr, uint16_t *len_buf)
{
mb_exception_t status = MB_EX_NONE;
(void)inst;
(void)frame_ptr;
if (!len_buf || !frame_ptr || !inst) {
return MB_EINVAL;
}
if (*len_buf == (MB_PDU_FUNC_WRITE_SIZE + MB_PDU_SIZE_MIN)
|| inst->transp_obj->frm_is_bcast(inst->transp_obj)) {
status = MB_EX_NONE;
} else {
/* Can't be a valid write coil register request because the length
* is incorrect. */
status = MB_EX_ILLEGAL_DATA_VALUE;
}
return status;
}
#endif
#if MB_FUNC_WRITE_MULTIPLE_COILS_ENABLED > 0
/**
* This function will request write multiple coils.
*
* @param snd_addr salve address
* @param coil_addr coil start address
* @param coil_num coil total number
* @param coil_data data to be written
* @param timeout timeout (-1 will waiting forever)
*
* @return error code
*
* @see mbm_rq_write_coil
*/
mb_err_enum_t mbm_rq_write_multi_coils(mb_base_t *inst, uint8_t snd_addr, uint16_t coil_addr, uint16_t coil_num, uint8_t *data_ptr, uint32_t tout)
{
uint8_t *mb_frame_ptr;
uint8_t *mb_data_ptr;
uint16_t reg_idx;
uint8_t byte_cnt;
if (snd_addr > MB_ADDRESS_MAX) {
return MB_EINVAL;
}
if (coil_num > MB_PDU_REQ_WRITE_MUL_COILCNT_MAX) {
return MB_EINVAL;
}
if (!mb_port_event_res_take(inst->port_obj, tout)) {
return MB_EBUSY;
}
inst->get_send_buf(inst, &mb_frame_ptr);
inst->set_dest_addr(inst, snd_addr);
mb_frame_ptr[MB_PDU_FUNC_OFF] = MB_FUNC_WRITE_MULTIPLE_COILS;
mb_frame_ptr[MB_PDU_REQ_WRITE_MUL_ADDR_OFF] = coil_addr >> 8;
mb_frame_ptr[MB_PDU_REQ_WRITE_MUL_ADDR_OFF + 1] = coil_addr;
mb_frame_ptr[MB_PDU_REQ_WRITE_MUL_COILCNT_OFF] = coil_num >> 8;
mb_frame_ptr[MB_PDU_REQ_WRITE_MUL_COILCNT_OFF + 1] = coil_num;
if ((coil_num & 0x0007) != 0) {
byte_cnt = (uint8_t)(coil_num / 8 + 1);
} else {
byte_cnt = (uint8_t)(coil_num / 8);
}
mb_frame_ptr[MB_PDU_REQ_WRITE_MUL_BYTECNT_OFF] = byte_cnt;
mb_data_ptr = mb_frame_ptr + MB_PDU_REQ_WRITE_MUL_VALUES_OFF;
for (reg_idx = 0; reg_idx < byte_cnt; reg_idx++) {
mb_data_ptr[reg_idx] = data_ptr[reg_idx];
}
inst->set_send_len(inst, (MB_PDU_SIZE_MIN + MB_PDU_REQ_WRITE_MUL_SIZE_MIN + byte_cnt));
(void)mb_port_event_post(inst->port_obj, EVENT(EV_FRAME_TRANSMIT | EV_TRANS_START) );
return mb_port_event_wait_req_finish(inst->port_obj);
}
mb_exception_t mbm_fn_write_multi_coils(mb_base_t *inst, uint8_t *frame_ptr, uint16_t *len_buf)
{
mb_exception_t status = MB_EX_NONE;
uint8_t *mb_frame_ptr;
uint16_t reg_address;
uint16_t coil_cnt;
uint8_t byte_cnt;
uint8_t byte_cnt_verify;
mb_err_enum_t reg_status = MB_EILLFUNC;
if (!len_buf || !frame_ptr || !inst) {
return MB_EINVAL;
}
/* If this request is broadcast, do not need to call r/w callback. */
if ((*len_buf == MB_PDU_FUNC_WRITE_MUL_SIZE)
|| inst->transp_obj->frm_is_bcast(inst->transp_obj)) {
inst->get_send_buf(inst, &mb_frame_ptr);
reg_address = (uint16_t)(frame_ptr[MB_PDU_FUNC_WRITE_MUL_ADDR_OFF] << 8);
reg_address |= (uint16_t)(frame_ptr[MB_PDU_FUNC_WRITE_MUL_ADDR_OFF + 1]);
reg_address++;
coil_cnt = (uint16_t)(frame_ptr[MB_PDU_FUNC_WRITE_MUL_COILCNT_OFF] << 8);
coil_cnt |= (uint16_t)(frame_ptr[MB_PDU_FUNC_WRITE_MUL_COILCNT_OFF + 1]);
byte_cnt = mb_frame_ptr[MB_PDU_REQ_WRITE_MUL_BYTECNT_OFF];
/* Compute the number of expected bytes in the request. */
if ((coil_cnt & 0x0007) != 0) {
byte_cnt_verify = (uint8_t)(coil_cnt / 8 + 1);
} else {
byte_cnt_verify = (uint8_t)(coil_cnt / 8);
}
if ((coil_cnt >= 1) && (byte_cnt_verify == byte_cnt)) {
if (inst->rw_cbs.reg_coils_cb) {
reg_status = inst->rw_cbs.reg_coils_cb(inst, &mb_frame_ptr[MB_PDU_REQ_WRITE_MUL_VALUES_OFF],
reg_address, coil_cnt, MB_REG_WRITE);
}
/* If an error occurred, convert it into a Modbus exception. */
if (reg_status != MB_ENOERR) {
status = mb_error_to_exception(reg_status);
}
} else {
status = MB_EX_ILLEGAL_DATA_VALUE;
}
} else {
/* Can't be a valid write coil register request because the length
* is incorrect. */
status = MB_EX_ILLEGAL_DATA_VALUE;
}
return status;
}
#endif // #if MB_FUNC_WRITE_MULTIPLE_COILS_ENABLED > 0
#endif // #if MB_MASTER_RTU_ENABLED || MB_MASTER_ASCII_ENABLED || MB_MASTER_TCP_ENABLED
Reference in New Issue View Git Blame Copy Permalink