From 5a7cd22bbe94798b333caf48a4cc23e593be4cf2 Mon Sep 17 00:00:00 2001 From: guishenking Date: Mon, 11 Aug 2025 20:42:20 +0800 Subject: [PATCH] =?UTF-8?q?=E7=AC=AC=E4=B8=80=E6=AC=A1=E6=8F=90=E4=BA=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + .vscode/tasks.json | 28 +++++ CMakeLists.txt | 37 ++++++ src/lib/crc/crc.c | 98 ++++++++++++++++ src/lib/crc/crc.h | 54 +++++++++ src/lib/kfifo/kfifo.c | 224 ++++++++++++++++++++++++++++++++++++ src/lib/kfifo/kfifo.h | 185 +++++++++++++++++++++++++++++ src/lib/protocol/protocol.c | 148 ++++++++++++++++++++++++ src/lib/protocol/protocol.h | 49 ++++++++ src/main.c | 48 ++++++++ 10 files changed, 872 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/tasks.json create mode 100755 CMakeLists.txt create mode 100755 src/lib/crc/crc.c create mode 100755 src/lib/crc/crc.h create mode 100755 src/lib/kfifo/kfifo.c create mode 100755 src/lib/kfifo/kfifo.h create mode 100755 src/lib/protocol/protocol.c create mode 100755 src/lib/protocol/protocol.h create mode 100755 src/main.c diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f3d6549 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/build/ \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..b8a2fc6 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,28 @@ +{ + "tasks": [ + { + "type": "cppbuild", + "label": "C/C++: gcc-14 生成活动文件", + "command": "/usr/bin/gcc-14", + "args": [ + "-fdiagnostics-color=always", + "-g", + "${file}", + "-o", + "${fileDirname}/${fileBasenameNoExtension}" + ], + "options": { + "cwd": "${fileDirname}" + }, + "problemMatcher": [ + "$gcc" + ], + "group": { + "kind": "build", + "isDefault": true + }, + "detail": "调试器生成的任务。" + } + ], + "version": "2.0.0" +} \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100755 index 0000000..6c506ad --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,37 @@ +cmake_minimum_required(VERSION 3.20) + +project(My_ptotocol VERSION 0.1 LANGUAGES CXX C) + +set(CMAKE_C_STANDARD 11) +set(CMAKE_C_COMPILER gcc) +set(CMAKE_C_STANDARD_REQUIRED ON) +# set(CMAKE_CXX_STANDARD 23) +# set(CMAKE_CXX_COMPILER g++) +# set(CMAKE_CXX_STANDARD_REQUIRED ON) + +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include) + +set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O0") +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O0") + +include_directories( + . + src/lib +) +set(PROJECT_SOURCES + src/main.c + src/lib/kfifo/kfifo.c + src/lib/protocol/protocol.c +) +add_executable(${PROJECT_NAME} + ${PROJECT_SOURCES} +) +target_link_libraries(${PROJECT_NAME} +) + +include(GNUInstallDirs) +install(TARGETS ${PROJECT_NAME} + BUNDLE DESTINATION . + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} +) \ No newline at end of file diff --git a/src/lib/crc/crc.c b/src/lib/crc/crc.c new file mode 100755 index 0000000..b40d094 --- /dev/null +++ b/src/lib/crc/crc.c @@ -0,0 +1,98 @@ +/** + * @file crc.c + * @author your name (you@domain.com) + * @brief + * @version 0.1 + * @date 2024-08-13 + * + * @copyright Copyright (c) 2024 + * + */ + +#include "crc.h" + +/* CRC16_XMODEM码表 */ +static const uint16_t CRC16Table_XMODEM[256] = { + 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7, 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF, 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6, 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE, 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, + 0x74C7, 0x44A4, 0x5485, 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D, 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4, 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC, 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823, 0xC9CC, 0xD9ED, + 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B, 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12, 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A, 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41, 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, + 0x9D49, 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70, 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78, 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F, 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067, 0x83B9, 0x9398, 0xA3FB, 0xB3DA, + 0xC33D, 0xD31C, 0xE37F, 0xF35E, 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256, 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D, 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405, 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C, 0x26D3, + 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634, 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB, 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3, 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A, 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, + 0x2AB3, 0x3A92, 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9, 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1, 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8, 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0 +}; + +/* CRC16_IBM码表 */ +static const uint16_t CRC16Table_IBM[256] = { + 0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241, 0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440, 0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40, 0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841, 0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, + 0xDBC1, 0xDA81, 0x1A40, 0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41, 0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641, 0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040, 0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240, 0x3600, 0xF6C1, + 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441, 0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41, 0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840, 0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41, 0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, + 0x2C40, 0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640, 0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041, 0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240, 0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441, 0x6C00, 0xACC1, 0xAD81, 0x6D40, + 0xAF01, 0x6FC0, 0x6E80, 0xAE41, 0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840, 0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41, 0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40, 0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640, 0x7200, + 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041, 0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241, 0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440, 0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40, 0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, + 0x5880, 0x9841, 0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40, 0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41, 0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641, 0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040 +}; + +static const uint32_t CRC32Table[256] = { + 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, + 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, + 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F, 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D, 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433, + 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01, 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65, + 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9, 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F, + 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD, 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, + 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B, + 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D, + 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777, + 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9, + 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D +}; + +uint8_t crc8_xor(uint8_t *data, uint32_t len) { + uint8_t val = 0x00; + + for (uint32_t i =0; i < len; ++i) { + val = data[i] ^ val; + } + + return val; +} + +uint16_t crc16_xmodem(const uint8_t *data, uint32_t len) { + uint16_t crc = 0; + uint16_t tmp; + + for (uint32_t i = 0; i < len; ++i) { + tmp = crc >> 8; + crc <<= 8; + + crc = crc ^ CRC16Table_XMODEM[(tmp ^ data[i] & 0xff)]; + } + + return crc; +} + +uint16_t crc16_ibm(const uint8_t *data, uint32_t len) { + uint16_t crcValue = 0; + uint16_t tableNo = 0; + + for (uint16_t i = 0; i < len; i++) + { + // tableNo = ((crcValue & 0xff) ^ (data[i] & 0xff)); + // crcValue = ((crcValue >> 8) & 0xff) ^ CRC16Table_IBM[tableNo & 0xFF]; + + crcValue = (crcValue >> 8) ^ CRC16Table_IBM[(crcValue ^ data[i]) & 0xff]; + } + + return crcValue; +} + +// uint32_t crc32(const uint8_t *data, uint32_t len) { +// uint32_t crc = 0xFFFFFFFF; +// uint16_t i = 0; +// for (i = 0; i < len; i++) +// { +// crc = (crc >> 8 ^ CRC32Table[(crc ^ data[i]) & 0xFF]); +// } +// crc = crc ^ 0xFFFFFFFF; +// return crc; +// } diff --git a/src/lib/crc/crc.h b/src/lib/crc/crc.h new file mode 100755 index 0000000..9d364de --- /dev/null +++ b/src/lib/crc/crc.h @@ -0,0 +1,54 @@ +/** + * @file crc.h + * @author your name (you@domain.com) + * @brief + * @version 0.1 + * @date 2024-08-13 + * + * @copyright Copyright (c) 2024 + * + */ + +#ifndef _MODULE_CRC_H_ +#define _MODULE_CRC_H_ + +#include + +#ifdef __cplusplus + extern "C" { +#endif + +uint8_t crc8_xor(uint8_t *data, uint32_t len); + +/** + * @brief CRC16 XMODEM 查表计算 + * + * @param[in] data + * @param[in] len + * @return uint16_t + */ +uint16_t crc16_xmodem(const uint8_t *data, uint32_t len); + +/** + * @brief CRC16 IBM 查表计算 + * + * @param[in] data + * @param[in] len + * @return uint16_t + */ +uint16_t crc16_ibm(const uint8_t *data, uint32_t len); + +/** + * @brief CRC32 查表计算 + * + * @param[in] data + * @param[in] len + * @return uint32_t + */ +// uint32_t crc32(const uint8_t *data, uint32_t len); + +#ifdef __cplusplus + } +#endif + +#endif /* !_MODULE_CRC_H_ */ diff --git a/src/lib/kfifo/kfifo.c b/src/lib/kfifo/kfifo.c new file mode 100755 index 0000000..e7ae592 --- /dev/null +++ b/src/lib/kfifo/kfifo.c @@ -0,0 +1,224 @@ +/** + * @file kfifo.c + * @author your name (you@domain.com) + * @brief + * @version 0.1 + * @date 2024-08-29 + * + * @copyright Copyright (c) 2024 + * + */ + +#include "kfifo.h" +#include + +#define get_pool_uint8_t(_fifo) ((uint8_t *)_fifo->pool) + +/** + * @brief 获取写入位置偏移量 + * + * @param[in] fifo + * @return uint32_t + */ +#define kfifo_offset_in(_fifo_ptr) ((_fifo_ptr)->in & (_fifo_ptr)->mask) + +/** + * @brief 获取读取位置偏移量 + * + * @param[in] fifo + * @return uint32_t + */ +#define kfifo_offset_out(_fifo_ptr) ((_fifo_ptr)->out & (_fifo_ptr)->mask) + +#define kfifo_offset_seek_out(_fifo_ptr, _seek) \ + (((_fifo_ptr)->out + (_seek)) & (_fifo_ptr)->mask) + +/** + * @brief 获取写入位置到缓冲区末尾的空间大小 + * + * @param[in] fifo + * @return uint32_t + */ +#define kfifo_remain_in(_fifo_ptr) \ + (kfifo_size(_fifo_ptr) - kfifo_offset_in(_fifo_ptr)) + +/** + * @brief 获取读取位置到缓冲区末尾的空间大小 + * + * @param[in] fifo + * @return uint32_t + */ +#define kfifo_remain_out(_fifo_ptr) \ + (kfifo_size(_fifo_ptr) - kfifo_offset_out(_fifo_ptr)) + +#define kfifo_remain_seek_out(_fifo_ptr, _seek) \ + (kfifo_size(_fifo_ptr) - kfifo_offset_seek_out(_fifo_ptr, _seek)) + +int kfifo_init(kfifo_t *fifo, void *pool, uint32_t size) { + /* 判断参数是否正确 */ + if ((NULL == fifo) || (NULL == pool) || (size & size - 1)) { + return -1; + } + + fifo->in = 0; + fifo->out = 0; + fifo->pool = pool; + fifo->mask = size - 1; + + return 0; +} + +int kfifo_put(kfifo_t *fifo, uint8_t data) { + if (kfifo_is_full(fifo)) { + return 0; + } + + get_pool_uint8_t(fifo)[kfifo_offset_in(fifo)] = data; + fifo->in++; + + return 1; +} + +int kfifo_get(kfifo_t *fifo, uint8_t *data) { + if (kfifo_is_empty(fifo)) { + return 0; + } + + *data = get_pool_uint8_t(fifo)[kfifo_offset_out(fifo)]; + fifo->out++; + + return 1; +} + +int kfifo_in(kfifo_t *fifo, const uint8_t *data, uint32_t len) { + uint32_t avail = kfifo_avail(fifo); + + if (len > avail) { + len = avail; + } + if (len == 0) { + return 0; + } + + if (kfifo_remain_in(fifo) < len) { + memcpy(fifo->pool + kfifo_offset_in(fifo), + data, + kfifo_remain_in(fifo)); + memcpy(fifo->pool, + data + kfifo_remain_in(fifo), + len - kfifo_remain_in(fifo)); + } else { + memcpy(fifo->pool + kfifo_offset_in(fifo), + data, + len); + } + + fifo->in += len; + + return len; +} + +int kfifo_out(kfifo_t *fifo, uint8_t *buffer, uint32_t size) { + uint32_t used = kfifo_used(fifo); + if (size > used) { + size = used; + } + if (0 == size) { + return 0; + } + + if (kfifo_remain_out(fifo) < size) { + memcpy(buffer, fifo->pool + kfifo_offset_out(fifo), kfifo_remain_out(fifo)); + memcpy(buffer + kfifo_remain_out(fifo), + fifo->pool, + size - kfifo_remain_out(fifo)); + } else { + memcpy(buffer, + fifo->pool + kfifo_offset_out(fifo), + size); + } + + fifo->out += size; + + return size; +} + +int kfifo_peek(kfifo_t *fifo, const uint8_t **ptr) { + int linear; + + *ptr = NULL; + + if (kfifo_is_empty(fifo)) { + return 0; + } + + *ptr = &get_pool_uint8_t(fifo)[kfifo_offset_out(fifo)]; + if (kfifo_offset_in(fifo) <= kfifo_offset_out(fifo)) { + linear = kfifo_remain_out(fifo); + } else { + linear = kfifo_used(fifo); + } + + return linear; +} + +int kfifo_peek_seek(kfifo_t *fifo, const uint8_t **ptr, uint32_t seek) { + *ptr = NULL; + + if (kfifo_used(fifo) < seek) { + return 0; + } + + // *ptr = &get_pool_uint8_t(fifo)[kfifo_offset_seek_out(fifo, seek)]; + *ptr = (uint8_t*)fifo->pool + kfifo_offset_seek_out(fifo, seek); + if (kfifo_remain_out(fifo) > seek) { + seek = kfifo_remain_seek_out(fifo, seek); + } else { + seek = kfifo_used(fifo) - seek; + } + + return seek; +} + +int kfifo_peek_block(kfifo_t *fifo, uint8_t *buffer, uint32_t size) { + int temp; + + if ((NULL == fifo) || (NULL == buffer) || (0 == size)) { + return -1; + } + + /* FIFO 中的数据量 */ + temp = kfifo_used(fifo); + if (!temp) { + return 0; + } + + if (size > temp) { + size = temp; + } + + temp = kfifo_remain_out(fifo); + + if (size > temp) { + memcpy(buffer, fifo->pool + kfifo_offset_out(fifo), temp); + memcpy(buffer + temp, + fifo->pool, + size - temp); + } else { + memcpy(buffer, + fifo->pool + kfifo_offset_out(fifo), + size); + } + + return size; +} + +int kfifo_seek(kfifo_t *fifo, uint32_t seek) { + if (kfifo_used(fifo) < seek) { + return 0; + } + + fifo->out += seek; + + return seek; +} diff --git a/src/lib/kfifo/kfifo.h b/src/lib/kfifo/kfifo.h new file mode 100755 index 0000000..7c110ed --- /dev/null +++ b/src/lib/kfifo/kfifo.h @@ -0,0 +1,185 @@ +/** + * @file kfifo.h + * @author your name (you@domain.com) + * @brief 仿 KFIFO 实现 + * @version 0.1 + * @date 2024-08-29 + * + * @copyright Copyright (c) 2024 + * + */ + +#ifndef _KFIFO_H_ +#define _KFIFO_H_ + +#include + +/** + * @brief kfifo 结构定义 + * + */ +struct kfifo { + uint32_t in; /*!< 输入数据下标, 对于单片机使用 volatile 修饰 */ + uint32_t out; /*!< 输出数据下标, 对于单片机使用 volatile 修饰 */ + uint32_t mask; + void *pool; +}; +typedef struct kfifo kfifo_t; + +/** + * @brief kfifo 初始化器 + * + * @param[in] _pool FIFO数据缓冲区 + * @param[in] _size 缓冲区大小 + */ +#define kfifo_initializer(_pool, _size) \ + { 0, 0, _size - 1, _pool, } + +/** + * @brief 定义 KFIFO + * + * @param[in] _name FIFO名称 + * @param[in] _size 缓冲区大小，必须是2的幂次 + */ +#define kfifo_def(_name, _size) \ + static uint8_t _##_name##_pool[_size]; \ + static kfifo_t _name = kfifo_initializer(_##_name##_pool, _size) + +#ifdef __cplusplus + extern "C" { +#endif + +/** + * @brief 初始化FIFO + * @note 使用@kfifo_def 定义的fifo无需调用此函数 + * @param[in] fifo + * @param[in] pool fifo 数据缓冲区 + * @param[in] size fifo 大小，必须是2的幂次 + * @return int + * @retval -1 参数错误、pool对齐错误 + * @retval 0 初始化完成 + */ +int kfifo_init(kfifo_t *fifo, void *pool, uint32_t size); + +#define kfifo_clear(_fifo_ptr) \ + do { \ + (_fifo_ptr)->in = 0; \ + (_fifo_ptr)->out = 0; \ + } while(0) + +/** + * @brief 向fifo写入一个字节 + * + * @param[in] fifo + * @param[in] data + * @return int + */ +int kfifo_put(kfifo_t *fifo, uint8_t data); + +/** + * @brief 获取一个字节 + * + * @param[in] fifo + * @param[in] data + * @return int + */ +int kfifo_get(kfifo_t *fifo, uint8_t *data); + +/** + * @brief 写入数据块 + * @note 当fifo空间不足时会对 data 进行截断处理 + * @param[in] fifo + * @param[in] data + * @param[in] len + * @return int 返回写入的数据大小 + */ +int kfifo_in(kfifo_t *fifo, const uint8_t *data, uint32_t len); + +/** + * @brief 读取数据块 + * + * @param[in] fifo + * @param[in] data + * @param[in] size + * @return int + */ +int kfifo_out(kfifo_t *fifo, uint8_t *data, uint32_t size); + +/** + * @brief 获取 fifo 数据指针 + * + * @param[in] fifo + * @param[in] ptr + * @return int 可连续读取的数据数量 + * @retval 0 fifo is empty + */ +int kfifo_peek(kfifo_t *fifo, const uint8_t **ptr); + +/** + * @brief 获取便宜后的 fifo 数据指针 + * + * @param[in] fifo + * @param[in] ptr + * @param[in] seek 偏移量 + * @return int 可连续读取的数据数量 + * @retval 0 fifo is empty + */ +int kfifo_peek_seek(kfifo_t *fifo, const uint8_t **ptr, uint32_t seek); + +/** + * @brief 复制数据到buffer而不更改 fifo 内指针位置 + * + * @param[in] fifo + * @param[in] buffer 存储数据的缓冲区 + * @param[in] size 需要复制的数据量 + * @return int + * @return -1 参数错误 + */ +int kfifo_peek_block(kfifo_t *fifo, uint8_t *buffer, uint32_t size); + +/** + * @brief fifo 数据指针偏移 seek 位置（丢弃数据） + * + * @param[in] fifo + * @param[in] seek + * @return int 实际偏移量 + * @retval 0 seek 大于实际数据量 + */ +int kfifo_seek(kfifo_t *fifo, uint32_t seek); + +/** + * @brief 获取fifo大小 + * + * @param[in] fifo + * @return uint32_t + */ +#define kfifo_size(_fifo_ptr) ((_fifo_ptr)->mask + 1) + +/** + * @brief 获取当前存储的数据量 + * + * @param[in] fifo + * @return uint32_t + */ +#define kfifo_used(_fifo_ptr) \ + (((kfifo_size(_fifo_ptr)) + (_fifo_ptr)->out) == (_fifo_ptr)->in \ + ? kfifo_size(_fifo_ptr) \ + : (((_fifo_ptr)->in - (_fifo_ptr)->out) & (_fifo_ptr)->mask)) + +/** + * @brief 获取空闲空间大小 + * + * @param[in] fifo + * @return uint32_t + */ +#define kfifo_avail(_fifo_ptr) (kfifo_size(_fifo_ptr) - kfifo_used(_fifo_ptr)) + +#define kfifo_is_full(_fifo_ptr) (kfifo_avail(_fifo_ptr) == 0) + +#define kfifo_is_empty(_fifo_ptr) (kfifo_used(_fifo_ptr) == 0) + +#ifdef __cplusplus + } +#endif + +#endif /* !_KFIFO_H_ */ diff --git a/src/lib/protocol/protocol.c b/src/lib/protocol/protocol.c new file mode 100755 index 0000000..d9d6114 --- /dev/null +++ b/src/lib/protocol/protocol.c @@ -0,0 +1,148 @@ +/** + * @file protocol.c + * @author guishenking (guishenking@outlook.com) + * @brief + * @version 0.1 + * @date 2025-07-25 + * + * @copyright Copyright (c) 2025 + * + */ +#include "protocol.h" +#include + +/** + * @brief + * + * @param src_data + * @param src_length + * @param dest_data + * @param dest_length + * @return int + */ +int data_encoder(const uint8_t *src_data, size_t src_length, + uint8_t *dest_data, size_t dest_length) +{ + // 参数校验 + if (!src_data || !dest_data) { + return PROTOCOL_ERR_INVALID_PARAM; + } + + // 计算所需缓冲区大小 + const size_t required_length = PROTOCOL_HEADER_SIZE + PROTOCOL_LENGTH_SIZE + + src_length + PROTOCOL_CHECKSUM_SIZE; + + if (dest_length < required_length) { + return PROTOCOL_ERR_BUF_TOO_SMALL; + } + + if (src_length > PROTOCOL_MAX_LENGTH) { + return PROTOCOL_ERR_PAYLOAD_TOO_LARGE; + } + + // 构建协议头 + dest_data[0] = PROTOCOL_START_BYTE1; + dest_data[1] = PROTOCOL_START_BYTE2; + + // 写入长度字段（大端序） + dest_data[2] = (src_length >> 8) & 0xFF; + dest_data[3] = src_length & 0xFF; + + // 复制有效载荷 + memcpy(&dest_data[4], src_data, src_length); + + // 计算并写入校验和 + uint8_t checksum = 0; + for (size_t i = 0; i < src_length; i++) { + checksum += src_data[i]; + } + dest_data[4 + src_length] = checksum; + + return PROTOCOL_SUCCESS; +} + +/** + * @brief + * + * @param src_data + * @param src_length + * @param dest_data + * @param dest_length + * @param offset + * @return int + */ +int data_decoder(const uint8_t *src_data, size_t src_length, + uint8_t *dest_data, size_t dest_length, + uint32_t *offset) +{ + // 参数校验 + if (!src_data || !dest_data || !offset) { + return PROTOCOL_ERR_INVALID_PARAM; + } + + // 检查最小帧长度 + if (src_length < PROTOCOL_MIN_FRAME_SIZE) { + return PROTOCOL_ERR_DATA_INCOMPLETE; + } + + // 查找起始字节 + uint32_t start_pos = 0; + for (; start_pos <= src_length - 2; start_pos++) { //预留和校验位置 + if (src_data[start_pos] == PROTOCOL_START_BYTE1 && + src_data[start_pos+1] == PROTOCOL_START_BYTE2) { + break; + } + } + + // 未找到起始字节 + if (start_pos > src_length - 2) { + *offset = src_length; + return PROTOCOL_ERR_NO_START_BYTE; + } + + // 解析长度字段 + const uint16_t payload_length = (src_data[start_pos+2] << 8) | src_data[start_pos+3]; + + // 检查长度有效性 + if (payload_length > PROTOCOL_MAX_LENGTH) { + *offset = start_pos; + return PROTOCOL_ERR_PAYLOAD_TOO_LARGE; + } + + // 计算完整帧长度 + const uint32_t frame_length = PROTOCOL_HEADER_SIZE + PROTOCOL_LENGTH_SIZE + + payload_length + PROTOCOL_CHECKSUM_SIZE; + + // 检查数据完整性 + if (start_pos + frame_length > src_length) { + *offset = start_pos; + return PROTOCOL_ERR_DATA_INCOMPLETE; + } + + // 检查输出缓冲区 + if (payload_length > dest_length) { + *offset = start_pos; + return PROTOCOL_ERR_BUF_TOO_SMALL; + } + + // 计算校验和 + const uint8_t *payload_start = &src_data[start_pos + 4]; + uint8_t checksum = 0; + for (uint16_t i = 0; i < payload_length; i++) { + checksum += payload_start[i]; + } + + // 验证校验和 + if (checksum != payload_start[payload_length]) { + *offset = start_pos + 1; // 跳过当前帧头 + return PROTOCOL_ERR_CHECKSUM; + } + + // 复制有效载荷 + memcpy(dest_data, payload_start, payload_length); + + // 更新偏移量 + *offset = start_pos + frame_length; + + return PROTOCOL_SUCCESS; +} \ No newline at end of file diff --git a/src/lib/protocol/protocol.h b/src/lib/protocol/protocol.h new file mode 100755 index 0000000..e50f0b5 --- /dev/null +++ b/src/lib/protocol/protocol.h @@ -0,0 +1,49 @@ +/** + * @file protocol.h + * @author guishenking (guishenking@outlook.com) + * @brief + * @version 0.1 + * @date 2025-07-24 + * + * @copyright Copyright (c) 2025 + * + */ +#ifndef _GSK_PROTOCOL_H_ +#define _GSK_PROTOCOL_H_ + +#include +#include + +// 协议常量定义 +#define PROTOCOL_START_BYTE1 (0xAA) +#define PROTOCOL_START_BYTE2 (0x55) +#define PROTOCOL_HEADER_SIZE (2) +#define PROTOCOL_LENGTH_SIZE (2) +#define PROTOCOL_CHECKSUM_SIZE (1) +#define PROTOCOL_MAX_LENGTH (1024) // 最大有效载荷长度 +#define PROTOCOL_MIN_FRAME_SIZE (PROTOCOL_HEADER_SIZE + PROTOCOL_LENGTH_SIZE + PROTOCOL_CHECKSUM_SIZE) + +// 错误码定义 +typedef enum { + PROTOCOL_SUCCESS = 0, + PROTOCOL_ERR_INVALID_PARAM = -1, + PROTOCOL_ERR_BUF_TOO_SMALL = -2, + PROTOCOL_ERR_NO_START_BYTE = -3, + PROTOCOL_ERR_CHECKSUM = -4, + PROTOCOL_ERR_DATA_INCOMPLETE = -5, + PROTOCOL_ERR_PAYLOAD_TOO_LARGE = -6 +} protocol_error_t; + +#ifdef __cplusplus +extern "C" { +#endif + +int data_encoder(const uint8_t *src_data, const size_t src_length, uint8_t *dest_data, size_t dest_length) ; + +int data_decoder(const uint8_t *src_data, const size_t src_length, uint8_t *dest_data, size_t dest_length, uint32_t *offset); + +#ifdef __cplusplus +} +#endif + +#endif // !_GSK_PROTOCOL_#define _GSK_PROTOCOL_H_ \ No newline at end of file diff --git a/src/main.c b/src/main.c new file mode 100755 index 0000000..07459e0 --- /dev/null +++ b/src/main.c @@ -0,0 +1,48 @@ +/** + * @file main.c + * @author guishenking (guishenking@outlook.com) + * @brief + * @version 0.1 + * @date 2025-07-24 + * + * @copyright Copyright (c) 2025 + * + */ + +#include "lib/protocol/protocol.h" +#include "lib/kfifo/kfifo.h" +#include +#include +#include + +kfifo_def(fifo,1024); + + int main(){ + // 示例数据 + uint8_t src_data[] = {0x01, 0x02, 0x03, 0x04, 0x05}; + size_t src_length = sizeof(src_data); + uint8_t dest_data[1024]; + size_t dest_length = sizeof(dest_data); + uint32_t offset; + + memset(dest_data, 0, dest_length); // 清空目标数据缓冲区 + + // 编码数据 + int result = data_encoder(src_data, src_length, dest_data, dest_length); + if (result != 0) { + return -1; // 编码失败 + } + kfifo_in(&fifo, dest_data, dest_length); // 将数据写入FIFO + + int ret = kfifo_peek_block(&fifo, dest_data, dest_length); // 从FIFO读取数据 + + memset(src_data, 0, src_length); // 清空源数据缓冲区 + + + // 解码数据 + result = data_decoder(dest_data, dest_length, src_data, src_length, &offset); + + kfifo_seek(&fifo, offset); // 根据偏移量调整FIFO读取位置 + + return 0; + } \ No newline at end of file