mbrtu.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. /*
  2. * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
  3. * Copyright (c) 2006-2018 Christian Walter <cwalter@embedded-solutions.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. */
  29. /* ----------------------- System includes ----------------------------------*/
  30. #include "stdlib.h"
  31. #include "string.h"
  32. /* ----------------------- Platform includes --------------------------------*/
  33. #include "port.h"
  34. /* ----------------------- Modbus includes ----------------------------------*/
  35. #include "mb.h"
  36. #include "mbrtu.h"
  37. #include "mbframe.h"
  38. #include "mbcrc.h"
  39. #include "mbport.h"
  40. /* ----------------------- Defines ------------------------------------------*/
  41. #define MB_SER_PDU_SIZE_MIN 4 /*!< Minimum size of a Modbus RTU frame. */
  42. #define MB_SER_PDU_SIZE_MAX 256 /*!< Maximum size of a Modbus RTU frame. */
  43. #define MB_SER_PDU_SIZE_CRC 2 /*!< Size of CRC field in PDU. */
  44. #define MB_SER_PDU_ADDR_OFF 0 /*!< Offset of slave address in Ser-PDU. */
  45. #define MB_SER_PDU_PDU_OFF 1 /*!< Offset of Modbus-PDU in Ser-PDU. */
  46. /* ----------------------- Type definitions ---------------------------------*/
  47. typedef enum
  48. {
  49. STATE_RX_INIT, /*!< Receiver is in initial state. */
  50. STATE_RX_IDLE, /*!< Receiver is in idle state. */
  51. STATE_RX_RCV, /*!< Frame is beeing received. */
  52. STATE_RX_ERROR /*!< If the frame is invalid. */
  53. } eMBRcvState;
  54. typedef enum
  55. {
  56. STATE_TX_IDLE, /*!< Transmitter is in idle state. */
  57. STATE_TX_XMIT /*!< Transmitter is in transfer state. */
  58. } eMBSndState;
  59. /* ----------------------- Static variables ---------------------------------*/
  60. static volatile eMBSndState eSndState;
  61. static volatile eMBRcvState eRcvState;
  62. volatile UCHAR ucRTUBuf[MB_SER_PDU_SIZE_MAX];
  63. static volatile UCHAR *pucSndBufferCur;
  64. static volatile USHORT usSndBufferCount;
  65. static volatile USHORT usRcvBufferPos;
  66. /* ----------------------- Start implementation -----------------------------*/
  67. eMBErrorCode
  68. eMBRTUInit( UCHAR ucSlaveAddress, UCHAR ucPort, ULONG ulBaudRate, eMBParity eParity )
  69. {
  70. eMBErrorCode eStatus = MB_ENOERR;
  71. ULONG usTimerT35_50us;
  72. ( void )ucSlaveAddress;
  73. ENTER_CRITICAL_SECTION( );
  74. /* Modbus RTU uses 8 Databits. */
  75. if( xMBPortSerialInit( ucPort, ulBaudRate, 8, eParity ) != TRUE )
  76. {
  77. eStatus = MB_EPORTERR;
  78. }
  79. else
  80. {
  81. /* If baudrate > 19200 then we should use the fixed timer values
  82. * t35 = 1750us. Otherwise t35 must be 3.5 times the character time.
  83. */
  84. if( ulBaudRate > 19200 )
  85. {
  86. usTimerT35_50us = 35; /* 1800us. */
  87. }
  88. else
  89. {
  90. /* The timer reload value for a character is given by:
  91. *
  92. * ChTimeValue = Ticks_per_1s / ( Baudrate / 11 )
  93. * = 11 * Ticks_per_1s / Baudrate
  94. * = 220000 / Baudrate
  95. * The reload for t3.5 is 1.5 times this value and similary
  96. * for t3.5.
  97. */
  98. usTimerT35_50us = ( 7UL * 220000UL ) / ( 2UL * ulBaudRate );
  99. //usTimerT35_50us +=2;
  100. }
  101. if( xMBPortTimersInit( ( USHORT ) usTimerT35_50us ) != TRUE )
  102. {
  103. eStatus = MB_EPORTERR;
  104. }
  105. }
  106. EXIT_CRITICAL_SECTION( );
  107. return eStatus;
  108. }
  109. void
  110. eMBRTUStart( void )
  111. {
  112. ENTER_CRITICAL_SECTION( );
  113. /* Initially the receiver is in the state STATE_RX_INIT. we start
  114. * the timer and if no character is received within t3.5 we change
  115. * to STATE_RX_IDLE. This makes sure that we delay startup of the
  116. * modbus protocol stack until the bus is free.
  117. */
  118. eRcvState = STATE_RX_INIT;
  119. vMBPortSerialEnable( TRUE, FALSE );
  120. vMBPortTimersEnable( );
  121. EXIT_CRITICAL_SECTION( );
  122. }
  123. void
  124. eMBRTUStop( void )
  125. {
  126. ENTER_CRITICAL_SECTION( );
  127. vMBPortSerialEnable( FALSE, FALSE );
  128. vMBPortTimersDisable( );
  129. EXIT_CRITICAL_SECTION( );
  130. }
  131. eMBErrorCode
  132. eMBRTUReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, USHORT * pusLength )
  133. {
  134. BOOL xFrameReceived = FALSE;
  135. eMBErrorCode eStatus = MB_ENOERR;
  136. ENTER_CRITICAL_SECTION( );
  137. //assert( usRcvBufferPos < MB_SER_PDU_SIZE_MAX );
  138. if(usRcvBufferPos >= MB_SER_PDU_SIZE_MAX)
  139. {
  140. eMBDisable();
  141. EXIT_CRITICAL_SECTION( );
  142. return eStatus;
  143. }
  144. /* Length and CRC check */
  145. if( ( usRcvBufferPos >= MB_SER_PDU_SIZE_MIN )
  146. && ( usMBCRC16( ( UCHAR * ) ucRTUBuf, usRcvBufferPos ) == 0 ) )
  147. {
  148. /* Save the address field. All frames are passed to the upper layed
  149. * and the decision if a frame is used is done there.
  150. */
  151. *pucRcvAddress = ucRTUBuf[MB_SER_PDU_ADDR_OFF];
  152. /* Total length of Modbus-PDU is Modbus-Serial-Line-PDU minus
  153. * size of address field and CRC checksum.
  154. */
  155. *pusLength = ( USHORT )( usRcvBufferPos - MB_SER_PDU_PDU_OFF - MB_SER_PDU_SIZE_CRC );
  156. /* Return the start of the Modbus PDU to the caller. */
  157. *pucFrame = ( UCHAR * ) & ucRTUBuf[MB_SER_PDU_PDU_OFF];
  158. xFrameReceived = TRUE;
  159. }
  160. else
  161. {
  162. eStatus = MB_EIO;
  163. }
  164. EXIT_CRITICAL_SECTION( );
  165. return eStatus;
  166. }
  167. eMBErrorCode
  168. eMBRTUSend( UCHAR ucSlaveAddress, const UCHAR * pucFrame, USHORT usLength )
  169. {
  170. eMBErrorCode eStatus = MB_ENOERR;
  171. USHORT usCRC16;
  172. ENTER_CRITICAL_SECTION( );
  173. /* Check if the receiver is still in idle state. If not we where to
  174. * slow with processing the received frame and the master sent another
  175. * frame on the network. We have to abort sending the frame.
  176. */
  177. if( eRcvState == STATE_RX_IDLE )
  178. {
  179. /* First byte before the Modbus-PDU is the slave address. */
  180. pucSndBufferCur = ( UCHAR * ) pucFrame - 1;
  181. usSndBufferCount = 1;
  182. /* Now copy the Modbus-PDU into the Modbus-Serial-Line-PDU. */
  183. pucSndBufferCur[MB_SER_PDU_ADDR_OFF] = ucSlaveAddress;
  184. usSndBufferCount += usLength;
  185. /* Calculate CRC16 checksum for Modbus-Serial-Line-PDU. */
  186. usCRC16 = usMBCRC16( ( UCHAR * ) pucSndBufferCur, usSndBufferCount );
  187. ucRTUBuf[usSndBufferCount++] = ( UCHAR )( usCRC16 & 0xFF );
  188. ucRTUBuf[usSndBufferCount++] = ( UCHAR )( usCRC16 >> 8 );
  189. //
  190. //插入以下代码完成一次发送,启动发送完成中断
  191. //
  192. xMBPortSerialPutByte( ( CHAR )*pucSndBufferCur );
  193. pucSndBufferCur++;
  194. usSndBufferCount--;
  195. //
  196. //结束
  197. //
  198. /* Activate the transmitter. */
  199. eSndState = STATE_TX_XMIT;
  200. vMBPortSerialEnable( FALSE, TRUE );
  201. }
  202. else
  203. {
  204. eStatus = MB_EIO;
  205. }
  206. EXIT_CRITICAL_SECTION( );
  207. return eStatus;
  208. }
  209. BOOL
  210. xMBRTUReceiveFSM( void )
  211. {
  212. BOOL xTaskNeedSwitch = FALSE;
  213. UCHAR ucByte;
  214. //assert( eSndState == STATE_TX_IDLE );
  215. // if(eSndState != STATE_TX_IDLE)
  216. // {
  217. // eMBDisable();
  218. // eSndState = STATE_TX_IDLE;
  219. // xMBPortSerialGetByte( ( CHAR * ) & ucByte );
  220. // return xTaskNeedSwitch;
  221. // }
  222. /* Always read the character. */
  223. ( void )xMBPortSerialGetByte( ( CHAR * ) & ucByte );
  224. switch ( eRcvState )
  225. {
  226. /* If we have received a character in the init state we have to
  227. * wait until the frame is finished.
  228. */
  229. case STATE_RX_INIT:
  230. vMBPortTimersEnable( );
  231. break;
  232. /* In the error state we wait until all characters in the
  233. * damaged frame are transmitted.
  234. */
  235. case STATE_RX_ERROR:
  236. vMBPortTimersEnable( );
  237. break;
  238. /* In the idle state we wait for a new character. If a character
  239. * is received the t1.5 and t3.5 timers are started and the
  240. * receiver is in the state STATE_RX_RECEIVCE.
  241. */
  242. case STATE_RX_IDLE:
  243. usRcvBufferPos = 0;
  244. ucRTUBuf[usRcvBufferPos++] = ucByte;
  245. eRcvState = STATE_RX_RCV;
  246. /* Enable t3.5 timers. */
  247. vMBPortTimersEnable( );
  248. break;
  249. /* We are currently receiving a frame. Reset the timer after
  250. * every character received. If more than the maximum possible
  251. * number of bytes in a modbus frame is received the frame is
  252. * ignored.
  253. */
  254. case STATE_RX_RCV:
  255. if( usRcvBufferPos < MB_SER_PDU_SIZE_MAX )
  256. {
  257. ucRTUBuf[usRcvBufferPos++] = ucByte;
  258. }
  259. else
  260. {
  261. eRcvState = STATE_RX_ERROR;
  262. }
  263. vMBPortTimersEnable( );
  264. break;
  265. }
  266. return xTaskNeedSwitch;
  267. }
  268. BOOL
  269. xMBRTUTransmitFSM( void )
  270. {
  271. BOOL xNeedPoll = FALSE;
  272. //assert( eRcvState == STATE_RX_IDLE );
  273. // if(eRcvState != STATE_RX_IDLE)
  274. // {
  275. // eMBDisable();
  276. // eRcvState = STATE_RX_IDLE;
  277. // return xNeedPoll;
  278. // }
  279. // if(eRcvState != STATE_RX_IDLE)
  280. // {
  281. // eMBDisable();
  282. // eMBRTUStart();
  283. // return xNeedPoll;
  284. // }
  285. switch ( eSndState )
  286. {
  287. /* We should not get a transmitter event if the transmitter is in
  288. * idle state. */
  289. case STATE_TX_IDLE:
  290. /* enable receiver/disable transmitter. */
  291. vMBPortSerialEnable( TRUE, FALSE );
  292. break;
  293. case STATE_TX_XMIT:
  294. /* check if we are finished. */
  295. if( usSndBufferCount != 0 )
  296. {
  297. xMBPortSerialPutByte( ( CHAR )*pucSndBufferCur );
  298. pucSndBufferCur++; /* next byte in sendbuffer. */
  299. usSndBufferCount--;
  300. }
  301. else
  302. {
  303. xNeedPoll = xMBPortEventPost( EV_FRAME_SENT );
  304. /* Disable transmitter. This prevents another transmit buffer
  305. * empty interrupt. */
  306. eSndState = STATE_TX_IDLE;
  307. vMBPortSerialEnable( TRUE, FALSE );
  308. //eSndState = STATE_TX_IDLE;
  309. }
  310. break;
  311. }
  312. return xNeedPoll;
  313. }
  314. BOOL
  315. xMBRTUTimerT35Expired( void )
  316. {
  317. BOOL xNeedPoll = FALSE;
  318. switch ( eRcvState )
  319. {
  320. /* Timer t35 expired. Startup phase is finished. */
  321. case STATE_RX_INIT:
  322. xNeedPoll = xMBPortEventPost( EV_READY );
  323. break;
  324. /* A frame was received and t35 expired. Notify the listener that
  325. * a new frame was received. */
  326. case STATE_RX_RCV:
  327. xNeedPoll = xMBPortEventPost( EV_FRAME_RECEIVED );
  328. break;
  329. /* An error occured while receiving the frame. */
  330. case STATE_RX_ERROR:
  331. break;
  332. /* Function called in an illegal state. */
  333. default:
  334. {
  335. // eMBDisable();
  336. // eRcvState = STATE_RX_IDLE;
  337. // return xNeedPoll;
  338. // assert( ( eRcvState == STATE_RX_INIT ) ||
  339. // ( eRcvState == STATE_RX_RCV ) || ( eRcvState == STATE_RX_ERROR ) );
  340. }
  341. }
  342. vMBPortTimersDisable( );
  343. eRcvState = STATE_RX_IDLE;
  344. return xNeedPoll;
  345. }