2e9272cc8a
引入成熟 IEC 60870-5-104 子站的只读子集(App/protocol/iec60870,28 个源文件 按原字节复制,UPSTREAM.sha256 记录来源,兼容补丁保留全部断言与容量),在其上 装配单属主共享核心(Start/Poll/Stop/Get_Status),并把标准 DTU 演示点表全量 接入为唯一真源。 - iec104_core:threadless 推进,poll 零等待,通知/交互/COV 扫描全部有界; 生命周期区分失败启动待重试、重复启动拒绝、断线保固化 RAM。 - iec104_dtu_table / iec104_source:标准 DTU 全点表注册,无数据源的点读 0, 遥控只做模拟状态可读回,不触碰实际出口。 - iec104_sim:仅窗口与独立服务模式起真实 TCP,无头黄金模式保持确定性假统计。 - test/host/iec104_dtu:独立真实 TCP 11 项、传输层 10 项、生命周期与借用负例。 验证:lvgl_sim 真实 TCP 11/11、传输 10/10,UI 像素回归未回退;AC5 单 TU 编译 0 错误 0 诊断。板端尚未切换:完整库闭包 RAM 超 92% 门禁净增预算 25730B, 结论为停止转实施,记录在 IEC104_MCU最小可行性验证.md。旧实现与 board 服务 保持原样,未提交 MDK 工程改动,未烧板。
375 lines
25 KiB
C
375 lines
25 KiB
C
/*
|
||
* IEC104配电自动化文件服务:国网扩展Type210的目录、读文件和写文件过程。
|
||
* 每Slave一个静态实例,读请求FIFO、独立写激活槽及固定数据段环;不建线程、不使用堆。
|
||
* Handle_Event/Process不调用应用,所有应用动作仅在Execute_Next同步执行。
|
||
* 目录与读文件必须保持快照;写入只进暂存,COMMIT才发布,成功后不得因回复失败回滚。
|
||
* 数据环满返回BUSY:调用者保留原事件,执行至多BUSY_STEP_LIMIT步后重试;不得读取后续通知。
|
||
* OPEN_WRITE/write/清理不等通知,COMMIT及所有发送必须通过原身份Check_Request。
|
||
* 在途任务、资源及最终收尾完成前保持同一handlers/context;禁止回调重入修改入口或推进Slave。
|
||
* 正常循环:分派通知(处理BUSY)-> Process -> Execute_Next -> Process;周期扫描最后推进。
|
||
* 退出:停止接入 -> Cancel -> Slave_Close -> 分派生命周期 -> 交付全部收尾 -> Destroy。
|
||
*/
|
||
#ifndef IEC104_FILE_SERVICE_H
|
||
#define IEC104_FILE_SERVICE_H
|
||
|
||
#include <stdbool.h>
|
||
#include <stddef.h>
|
||
#include <stdint.h>
|
||
#include "IEC104_Slave.h"
|
||
#include "IEC60870_Time.h"
|
||
|
||
#ifdef __cplusplus
|
||
extern "C" {
|
||
#endif
|
||
|
||
typedef struct IEC104_FileService IEC104_FileService_t;
|
||
|
||
/* 专用类型不加入公共信息对象表;不得与标准Type120的F_FR_NA_1混用。
|
||
* 249字节ASDU减去各操作头部,得到数据段和名称上限;名称长度不包含NUL。
|
||
* BUSY上界仅适用于合法入口、回调完整且没有新故障的本地推进。 */
|
||
#define IEC104_FILE_SERVICE_TYPE_ID 210U
|
||
#define IEC104_FILE_SERVICE_PACKAGE_FILE 2U
|
||
#define IEC104_FILE_SERVICE_MAX_SEGMENT 228U
|
||
#define IEC104_FILE_SERVICE_MAX_FILE_NAME 228U
|
||
#define IEC104_FILE_SERVICE_MAX_DIRECTORY_NAME 218U
|
||
#define IEC104_FILE_SERVICE_BUSY_STEP_LIMIT 7U
|
||
|
||
/* 功能位只控制业务受理;关闭功能后,已识别的激活仍按对应操作回失败结果。 */
|
||
#define IEC104_FILE_SERVICE_FEATURE_DIRECTORY 0x01U
|
||
#define IEC104_FILE_SERVICE_FEATURE_READ 0x02U
|
||
#define IEC104_FILE_SERVICE_FEATURE_WRITE 0x04U
|
||
#define IEC104_FILE_SERVICE_FEATURE_ALL 0x07U
|
||
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_SEGMENT_UNCHECKED = 0, /* 显式兼容:按到达顺序拼接,不能检测等长重复/乱序。 */
|
||
IEC104_FILE_SERVICE_SEGMENT_OFFSET = 1 /* 默认:段号等于已收字节数,读路径始终使用小端偏移。 */
|
||
} IEC104_FileServiceSegmentMode_t;
|
||
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_WRITE_CONFIRM_FINAL = 0, /* 默认:末段或错误时确认。 */
|
||
IEC104_FILE_SERVICE_WRITE_CONFIRM_EACH = 1 /* 每段确认;容量不足只允许丢非末段确认。 */
|
||
} IEC104_FileServiceWriteConfirmMode_t;
|
||
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_READ_CONFIRM_COUNT = 0, /* 默认只统计op6;非零结果不是细则定义的失败码。 */
|
||
IEC104_FILE_SERVICE_READ_CONFIRM_STOP_NONZERO = 1, /* 仅数据阶段的匹配op6且结果非零时停发。 */
|
||
IEC104_FILE_SERVICE_READ_CONFIRM_STOP_ANY = 2 /* 数据阶段的任意匹配op6均停发;须与主站约定。 */
|
||
} IEC104_FileServiceReadConfirmMode_t;
|
||
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_ID_ZERO = 0, /* 默认按预留字段发零。 */
|
||
IEC104_FILE_SERVICE_ID_ECHO = 1 /* 显式兼容:目录和写确认回显请求ID,读文件仍为零。 */
|
||
} IEC104_FileServiceIdMode_t;
|
||
|
||
/* OPEN返回OK后模块才取得handle;释放责任由对应收尾回调承担。
|
||
* CALL_NONE不是动作入口,仅用于标识list/read/write的借用请求。 */
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_CALL_NONE = 0, /* list/read/write的请求。 */
|
||
IEC104_FILE_SERVICE_CALL_OPEN_DIRECTORY, /* 固定目录清单;本轮成功后不再调用list。 */
|
||
IEC104_FILE_SERVICE_CALL_CLOSE_DIRECTORY, /* 释放快照,之后不再list。 */
|
||
IEC104_FILE_SERVICE_CALL_OPEN_READ, /* 固定文件内容,输出大小和可选确认回显名。 */
|
||
IEC104_FILE_SERVICE_CALL_OPEN_WRITE, /* 校验应用权限与容量,只创建暂存资源。 */
|
||
IEC104_FILE_SERVICE_CALL_COMMIT, /* 完整长度已通过,原身份READY后发布并释放暂存。 */
|
||
IEC104_FILE_SERVICE_CALL_CLOSE_READ, /* 释放读锁或快照,之后不再read。 */
|
||
IEC104_FILE_SERVICE_CALL_ABORT_WRITE /* 丢弃暂存;不能影响其他会话或已提交文件。 */
|
||
} IEC104_FileServiceCall_t;
|
||
|
||
/* 仅收尾请求使用reason;COMPLETE只表示末帧已交发送层,不证明主站收到。 */
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_END_NONE = 0,
|
||
IEC104_FILE_SERVICE_END_COMPLETE,
|
||
IEC104_FILE_SERVICE_END_MASTER, /* 匹配op6按配置要求停止读数据。 */
|
||
IEC104_FILE_SERVICE_END_SUPERSEDED, /* 已受理的新同类激活取代旧会话,满槽丢新不取代。 */
|
||
IEC104_FILE_SERVICE_END_ERROR, /* 应用取值/写入或字段校验失败;不保证错误回复已交出。 */
|
||
IEC104_FILE_SERVICE_END_TIMEOUT, /* 目录总期限、读写进度或COMMIT预留回复期限到期。 */
|
||
IEC104_FILE_SERVICE_END_CANCELLED /* Cancel、生命周期失效或发送故障;未交COMMIT改为放弃。 */
|
||
} IEC104_FileServiceEndReason_t;
|
||
|
||
/* 回调期只读借用,逐次初始化,不得保存指针。
|
||
* identity原样贯穿检查、发送和关闭;instance_id是模块编号,不能替代Slave实例编号。
|
||
* station_id固定原注册身份,同CA重注册不继承旧文件句柄。清理沿用成功OPEN的来源。
|
||
* name是不带NUL的字节串,模块不解析路径或权限;read/write与收尾不携带名称。
|
||
* OA只用于回复和诊断,不能充当认证。升级目标绑定由应用按完整身份和独立token完成。 */
|
||
typedef struct {
|
||
IEC104_SlaveEventIdentity_t identity;
|
||
uint64_t instance_id;
|
||
uint64_t receive_serial; /* 发起请求/会话的原I帧流水号;读写和收尾沿用激活帧,不是当前数据段N(S)。 */
|
||
uint64_t station_id;
|
||
uint16_t common_address;
|
||
uint8_t originator_address;
|
||
IEC104_FileServiceCall_t call;
|
||
IEC104_FileServiceEndReason_t reason;
|
||
bool test; /* TEST目录/读照常只读;TEST写不调用任何应用回调。 */
|
||
const uint8_t *name;
|
||
uint8_t name_length; /* 目录为0表示默认目录;文件激活必须非空。 */
|
||
bool time_filter; /* 目录过滤由模块完成,list仍按原快照顺序枚举。 */
|
||
IEC60870_CP56Time2a_t start_time, stop_time; /* 未启用过滤时清零。 */
|
||
uint32_t file_id; /* 写为op7原ID,读为0;与线上ZERO/ECHO模式分开。 */
|
||
uint32_t file_size; /* 写为激活声明大小;读会话为OPEN_READ成功输出的大小,目录为0。 */
|
||
uintptr_t handle; /* 应用不透明句柄,0可以有效。 */
|
||
uint32_t transferred; /* COMMIT/CLOSE_READ/ABORT_WRITE中的进度;read/write用独立offset,其他调用为0。 */
|
||
uint64_t accepted_ms; /* 发起请求的Net单调毫秒,WAIT不会刷新。 */
|
||
} IEC104_FileServiceRequest_t;
|
||
|
||
/* list返回后即时复制名称;指针至少有效到复制完成,不能指向回调的局部栈数组。 */
|
||
typedef struct {
|
||
const uint8_t *name;
|
||
uint8_t name_length; /* 1..218,不带结束符。 */
|
||
uint8_t attribute; /* 预留属性,未约定时填0。 */
|
||
uint32_t size;
|
||
IEC60870_CP56Time2a_t time; /* 必须可编码;过滤开启时IV项跳过,否则保留IV原意。 */
|
||
} IEC104_FileServiceEntry_t;
|
||
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_LIST_ERROR = -1, /* 放弃本轮未交出的条目,转固定错误末帧并关闭快照。 */
|
||
IEC104_FILE_SERVICE_LIST_END = 0, /* 正常结束;index=0时表示存在的空目录。 */
|
||
IEC104_FILE_SERVICE_LIST_ENTRY = 1, /* entry各字段有效;即使随后被过滤,也先做合法性检查。 */
|
||
IEC104_FILE_SERVICE_LIST_NO_DIRECTORY = 2 /* 仅index=0有效,与存在但为空的目录区分。 */
|
||
} IEC104_FileServiceListResult_t;
|
||
|
||
/* OPEN_DIRECTORY固定清单后按index从0枚举,不能在index=0重建快照。
|
||
* 先校验ENTRY再按时段过滤;发送WAIT会重取同一下标,名称/时间/大小/顺序须保持不变。
|
||
* entry进入回调前清零;END/NO_DIRECTORY忽略其他输出,ENTRY名称由模块即时复制。
|
||
* index=SIZE_MAX只能以END正常结束,ENTRY不能自增回绕;每轮调用数受list_scan_budget限制。
|
||
* 预算边界可跨轮前瞻并重取待发页:index不保证单调增加,回调不能把枚举当成一次性消费。
|
||
* 非空匹配结果的最后一帧仍含条目;空结果正常发送零项末帧,不虚构文件规避客户端限制。 */
|
||
typedef IEC104_FileServiceListResult_t (*IEC104_FileServiceList_t)(void *context,
|
||
const IEC104_FileServiceRequest_t *request, size_t index, IEC104_FileServiceEntry_t *entry);
|
||
|
||
/* OPEN_DIRECTORY/OPEN_READ/COMMIT只区分OK与失败;2、3仅用于写激活的细分结果。
|
||
* 非法枚举按失败收尾并计invalid_callbacks,不能借未知返回值保留暂存或资源。 */
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_RESULT_OK = 0,
|
||
IEC104_FILE_SERVICE_RESULT_FAILED = 1,
|
||
IEC104_FILE_SERVICE_RESULT_NAME_UNSUPPORTED = 2, /* 只用于OPEN_WRITE。 */
|
||
IEC104_FILE_SERVICE_RESULT_SIZE_OUT_OF_RANGE = 3 /* 只用于OPEN_WRITE。 */
|
||
} IEC104_FileServiceResult_t;
|
||
|
||
/* 调用前清零。OPEN_DIRECTORY/OPEN_WRITE只使用handle,OPEN_READ另使用size及可选回显名。 */
|
||
typedef struct {
|
||
uint32_t size;
|
||
uintptr_t handle;
|
||
const uint8_t *name; /* OPEN_READ为NULL时回显原名,否则必须至少有效到返回后的即时复制。 */
|
||
uint8_t name_length; /* 非NULL名称为1..228;name为NULL时忽略。 */
|
||
} IEC104_FileServiceOpen_t;
|
||
|
||
/* 同步短时;两次Slave推进之间所有写回调累计耗时也须远小于主站t1-t2。
|
||
* OPEN_*非OK须在返回前释放临时资源,不会收到收尾;成功OPEN恰好收尾一次。
|
||
* 目录/读分别CLOSE_DIRECTORY/CLOSE_READ;写为COMMIT或ABORT_WRITE之一。
|
||
* COMMIT是不可撤销发布边界:成功后回复丢失不再ABORT;失败须保持旧文件并释放暂存。
|
||
* CLOSE/ABORT返回值忽略,open=NULL;COMMIT也以open=NULL调用。
|
||
* COMMIT等待读空通知期间,新写激活可能先执行,只有一个暂存区时应用可拒绝该OPEN。
|
||
* 回调仅允许Get_Status等只读跨模块查询,不能推进Slave或保存借用请求。 */
|
||
typedef IEC104_FileServiceResult_t (*IEC104_FileServiceAction_t)(void *context,
|
||
const IEC104_FileServiceRequest_t *request, IEC104_FileServiceOpen_t *open);
|
||
|
||
/* 读出恰好length字节;会话期间文件内容固定,WAIT后同offset须返回相同数据。
|
||
* buffer由模块借出,仅本轮有效;空文件也会以length=0调用,不得要求一次读取必有数据。
|
||
* false使本次读取进入固定空末段中止;后续重试不再read。IDLE尚未准入时不调用本回调。 */
|
||
typedef bool (*IEC104_FileServiceRead_t)(void *context, const IEC104_FileServiceRequest_t *request,
|
||
uint32_t offset, uint8_t *buffer, uint16_t length);
|
||
|
||
/* 只写暂存,offset为已经写入的字节数,length可为0,last表示无后续。
|
||
* 模块已检查长度、校验码、ID及配置的偏移规则;同一受理段不会调用两次。
|
||
* data只在本轮有效,返回前须已完成复制或暂存,不能保存该指针供后台读取。
|
||
* false形成结果1并安排ABORT_WRITE,成功非空写才刷新进度期限。 */
|
||
typedef bool (*IEC104_FileServiceWrite_t)(void *context, const IEC104_FileServiceRequest_t *request,
|
||
uint32_t offset, const uint8_t *data, uint16_t length, bool last);
|
||
|
||
typedef struct {
|
||
IEC104_FileServiceList_t list; /* 启用DIRECTORY必需,未启用可为NULL。 */
|
||
IEC104_FileServiceAction_t action; /* 任意功能都需要,含TEST与待清理阶段的入口校验。 */
|
||
IEC104_FileServiceRead_t read; /* 启用READ必需,包含TEST读取。 */
|
||
IEC104_FileServiceWrite_t write; /* 启用WRITE必需;TEST虽不调用,入口仍要求完整环境。 */
|
||
} IEC104_FileServiceHandlers_t;
|
||
|
||
/* Create按值复制且实例内冻结。所有期限单位ms;reply必须>0,其余0禁用。
|
||
* 期限启用时now回退或elapsed>=timeout均到期,WAIT/重复段不重置期限。 */
|
||
typedef struct {
|
||
uint8_t features; /* FEATURE_*非空组合,不接受未定义位。 */
|
||
IEC104_FileServiceSegmentMode_t segment_mode;
|
||
IEC104_FileServiceWriteConfirmMode_t write_confirm_mode;
|
||
IEC104_FileServiceReadConfirmMode_t read_confirm_mode;
|
||
IEC104_FileServiceIdMode_t id_mode;
|
||
bool allow_short_directory_request; /* 默认false;仅允许召唤标志0完全省略14字节时标。 */
|
||
uint8_t write_confirm_cause; /* 7或5。 */
|
||
uint16_t read_segment_bytes; /* 1..228。 */
|
||
uint16_t window_reserve; /* 非零;激活时须小于k和发送记录容量。 */
|
||
uint16_t list_scan_budget; /* 1..65535,每轮list调用上限;过滤、前瞻和重建同样消耗预算。 */
|
||
uint32_t directory_timeout_ms; /* OPEN_DIRECTORY成功至正常末帧交出,包含过滤和WAIT,不是逐帧期限。 */
|
||
uint32_t reply_timeout_ms; /* 形成即计时,包含未执行COMMIT的实际预留回复槽。 */
|
||
uint32_t execute_timeout_ms; /* 从受理计时;读FIFO仅队首检查,写激活槽独立检查。 */
|
||
uint32_t read_idle_timeout_ms; /* op4或上一段交出至下一段的间隔;HIGH/NORMAL拥塞同样计入。 */
|
||
uint32_t write_idle_timeout_ms; /* op8交出/最近成功非空write的较晚时刻起算。 */
|
||
} IEC104_FileServiceConfig_t;
|
||
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_EVENT_ERROR = -1, /* 参数/来源/重入或准备失败;不得继续当未知类型回44。 */
|
||
IEC104_FILE_SERVICE_EVENT_IGNORED = 0, /* 本模块未接手,应用可继续分派给其他业务。 */
|
||
IEC104_FILE_SERVICE_EVENT_HANDLED = 1, /* 含拒绝、丢新、faulted消费,不表示已回复。 */
|
||
IEC104_FILE_SERVICE_EVENT_BUSY = 2 /* 仅op9;未受理且原事件不变,先执行再重试同一事件。 */
|
||
} IEC104_FileServiceEventResult_t;
|
||
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_EXECUTE_ERROR = -1, /* 入口错误或本轮回调前的新故障,可能已安排清理。 */
|
||
IEC104_FILE_SERVICE_EXECUTE_EMPTY = 0, /* 当前无本入口可推进项;固定回复或暂缓COMMIT可能仍占槽。 */
|
||
IEC104_FILE_SERVICE_EXECUTE_WAIT = 1, /* 纯等通知/容量;正常list/read可能已调用,候选帧未交出。 */
|
||
IEC104_FILE_SERVICE_EXECUTE_OK = 2 /* 含消费残段、到期清理等无回调推进,不等于业务成功。 */
|
||
} IEC104_FileServiceExecuteResult_t;
|
||
|
||
/* 集中仲裁把文件召唤级10与传输级11分开推进;原Execute_Next等价于ALL。
|
||
* 模式不等于发送许可:DATA仍检查op4已HANDED、窗口及当前等级;也不暂停CONTROL资源清理。 */
|
||
typedef enum {
|
||
IEC104_FILE_SERVICE_EXECUTE_ALL = 0,
|
||
IEC104_FILE_SERVICE_EXECUTE_CONTROL = 1, /* 收尾、目录、OPEN、写入及COMMIT;不读取op5数据。 */
|
||
IEC104_FILE_SERVICE_EXECUTE_DATA = 2 /* 仅已打开读会话的数据;仍检查期限/身份/确认交接。 */
|
||
} IEC104_FileServiceExecuteMode_t;
|
||
|
||
/* 计数自Create累计;Cancel/生命周期不清零,计数溢出不参与协议正确性。
|
||
* 调度使用events_pending || execute_ready || need_process,不用execute_pending直接零等待。
|
||
* 这是调用时刻的快照,不是执行许可;网络推进后须重新查询并重试之前的WAIT。
|
||
* 回调期间可查询诊断,但execute_ready/need_process/timer_active被抑制,不能据此递归执行。 */
|
||
typedef struct {
|
||
uint64_t generation; /* 由生命周期通知建立的当前代次,不是累计计数。 */
|
||
/* active记录启停状态,faulted时即使active也不得执行业务。
|
||
* execute_pending只表示有工作;execute_ready包括不等通知的写本地步骤和资源清理。
|
||
* need_process用于可提交固定回复、期限及失效处理,发送WAIT后不要求空转。 */
|
||
bool active, events_pending, execute_pending, execute_ready, need_process, timer_active;
|
||
/* active只反映当前打开资源;移入收尾记录后变false,仍须检查finish_pending。 */
|
||
bool read_active, write_active, write_test;
|
||
bool segments_full; /* 当前数据环满;BUSY重试必须保留原事件,而不是构造新事件。 */
|
||
bool idle_waiting; /* 上次读数据准入或提交WAIT,偏移未推进,网络唤醒后再取。 */
|
||
bool finish_pending; /* 包含暂缓COMMIT;清理可在断线及faulted后交付。 */
|
||
/* 目录等待CLOSE仍为active;CLOSE已交付而错误回复仍等待时,快照已不活跃。
|
||
* faulted粘滞至销毁重建;原连接结束只解除Destroy前置条件,不自动恢复业务。 */
|
||
bool directory_active, faulted;
|
||
bool commit_waiting; /* 已安排COMMIT且仍有未分派Slave通知;不阻塞本地写入/清理。 */
|
||
bool reserve_invalid; /* 本代次reserve不满足发送容量;仅拒绝读文件激活,其他功能继续。 */
|
||
uint32_t timeout_remaining_ms; /* 0同时可表示无计时;须结合timer_active。 */
|
||
/* requests含读FIFO和写激活槽(含其待发回复);replies也含这些固定回复,不能简单相加。
|
||
* segments只计数据环,独立资源/收尾不计入requests。 */
|
||
unsigned pending_requests, pending_segments, pending_replies; /* replies含RESERVED_COMMIT。 */
|
||
uint32_t read_offset, read_size, write_received, write_size; /* 当前打开会话的进度;收尾最终值由Request携带。 */
|
||
/* accepted是协议入槽,不是文件生效;错误再遇满槽可同时计rejected和dropped_requests。
|
||
* dropped_replies只统计EACH模式被驱逐/丢新的非末段确认,终结和COMMIT预留不可驱逐。 */
|
||
unsigned long accepted, rejected, dropped_requests, dropped_replies, busy_returns, timeouts;
|
||
unsigned long directories, directory_frames, directory_failures;
|
||
unsigned long reads_opened, read_frames, reads_completed, reads_aborted, read_timeouts;
|
||
unsigned long read_confirms, read_confirm_nonzero; /* 匹配op6的计数;非零不自动解释为规范失败码。 */
|
||
/* opened/written/committed为真实应用成功,不计TEST写模拟;failed/timeout仍覆盖协议模拟失败。 */
|
||
unsigned long writes_opened, segments_written, writes_committed, writes_failed, write_timeouts;
|
||
unsigned long commits_cancelled, stray_segments;
|
||
/* submitted仅代表发送层接手。negative同时识别P/N和操作结果码,COT5失败也可能计入。
|
||
* waits/idle_waits按每次实际等待累计;finishes只在应用收尾交付时累计。 */
|
||
unsigned long submitted, negative_submitted, waits, idle_waits, cancelled, finishes;
|
||
unsigned long directory_timeouts, reply_timeouts, invalid_callbacks, send_errors, close_errors;
|
||
unsigned long serial_exhausted, faulted_dropped;
|
||
} IEC104_FileServiceStatus_t;
|
||
|
||
/**
|
||
* 功能:全功能、OFFSET/FINAL/COUNT/ZERO,op10原因7,段228,reserve2,list预算64;
|
||
* 输入参数:config——配置。
|
||
* 输出参数:config——配置的更新结果。
|
||
* 返回值:无。
|
||
* 说明:directory/reply/execute/read/write期限为60000/15000/15000/60000/60000ms。NULL无操作。
|
||
*/
|
||
void IEC104_FileService_Config_Default(IEC104_FileServiceConfig_t *config);
|
||
/**
|
||
* 功能:早于消费首条Slave通知;允许Init前创建。非法配置、重复绑定、池满或编号耗尽返回NULL。
|
||
* 输入参数:slave——所属从站服务。
|
||
* config——配置。
|
||
* 输出参数:无。
|
||
* 返回值:按处理分支返回NULL、slot。
|
||
* 说明:固定104头COT/CA/IOA=2/2/3。实现容量宏默认TCP容量/请求2/段2/确认2,确认至少2,其他至少1。
|
||
* 成功后持有Slave借用,调用者须让Slave活到模块Destroy;配置被复制,不保存config指针。
|
||
* window_reserve与实际k/记录槽的关系在ACTIVATED时检查,不在未初始化Slave上猜测容量。
|
||
*/
|
||
IEC104_FileService_t *IEC104_FileService_Create(IEC104_Slave_t *slave,
|
||
const IEC104_FileServiceConfig_t *config);
|
||
/**
|
||
* 功能:不隐式取消;请求/数据/回复/资源/待收尾未清空或回调中均失败,不归还池槽。
|
||
* 输入参数:self——本模块实例。
|
||
* 输出参数:self——本模块实例的更新结果。
|
||
* 返回值:self->write_finish[i].occupied时返回false;self->confirms[i].occupied时返回false;!self->fault_ended时返回false;其余分支返回false、true。
|
||
* 说明:faulted且关闭失败时,还须证实原连接已终结,不能用Destroy/Create绕过故障边界。
|
||
* true之后旧句柄失效;函数不销毁Slave,也不替应用释放文件存储。
|
||
*/
|
||
bool IEC104_FileService_Destroy(IEC104_FileService_t *self);
|
||
/**
|
||
* 功能:清全部队列;未交COMMIT改ABORT,清理保留原身份/handle/站点引用到交付。
|
||
* 输入参数:self——本模块实例。
|
||
* 输出参数:self——本模块实例的更新结果。
|
||
* 返回值:无。
|
||
* 说明:健康连接对最高未提交写会话留一次无声结束标记;已COMMIT不改判失败。
|
||
* 不撤回已交出帧、不回滚已提交文件;无效句柄/回调重入无操作。
|
||
* 本调用不执行清理回调、不停用健康模块;返回后须继续Execute_Next归还成功OPEN的资源。
|
||
*/
|
||
void IEC104_FileService_Cancel(IEC104_FileService_t *self);
|
||
/**
|
||
* 功能:按Slave FIFO分派;生命周期广播其他模块,HANDLED/ERROR的I帧不得再落44。
|
||
* 输入参数:self——本模块实例。
|
||
* event——事件。
|
||
* 输出参数:self——本模块实例的更新结果。
|
||
* 返回值:返回IEC104_FileServiceEventResult_t结果;本函数显式处理IEC104_FILE_SERVICE_EVENT_ERROR、IEC104_FILE_SERVICE_EVENT_IGNORED、IEC104_FILE_SERVICE_EVENT_HANDLED、IEC104_FILE_SERVICE_TASK_CAPACITY、IEC104_FILE_SERVICE_EVENT_BUSY,其余结果由下层调用传回。
|
||
* 说明:BUSY时保留同一event,最多BUSY_STEP_LIMIT次Execute_Next解除正常背压,不读后续通知。
|
||
* 返回HANDLED包含满请求槽丢新;只有实际保存的新激活才取代旧会话。
|
||
* 参数校验和必要字节复制均在本次完成,受理后不保存event或ASDU视图的借用指针。
|
||
*/
|
||
IEC104_FileServiceEventResult_t IEC104_FileService_Handle_Event(IEC104_FileService_t *self,
|
||
const IEC104_SlaveEvent_t *event);
|
||
/**
|
||
* 功能:有界检查期限及按形成序号提交HIGH回复,不调用应用。网络推进后即使need_process=false也重试。
|
||
* 输入参数:self——本模块实例。
|
||
* 输出参数:self——本模块实例的更新结果。
|
||
* 返回值:每轮即使need_process=false也可调用以重试WAIT。
|
||
* true表示本轮正常结束,不表示队列已空。
|
||
* 说明:false表示入口/查询/发送/关闭故障或已faulted,不表示此前COMMIT失败。
|
||
* true可仍有WAIT、未执行请求或待清理资源;队列是否为空应从Get_Status分别判断。
|
||
*/
|
||
bool IEC104_FileService_Process(IEC104_FileService_t *self);
|
||
/**
|
||
* 功能:优先清理,再写激活/写段,再FIFO队首,再IDLE读段;暂缓COMMIT不阻挡本地步骤。
|
||
* 输入参数:self——本模块实例。
|
||
* handlers——回调集合。
|
||
* context——调用方上下文。
|
||
* 输出参数:self——本模块实例的更新结果。
|
||
* 返回值:回调借用及返回语义沿用模式入口。
|
||
* 说明:每轮至多一次action/read/write或list_scan_budget次list,OPEN_DIRECTORY本轮不再list。
|
||
* 本轮回调后新故障返回OK并安排清理;纯list/read组帧WAIT可返回WAIT且允许重取。
|
||
* 在途任务至最终收尾须保持同一函数集合/context,结构体本身只在调用期借用。
|
||
* 已启用功能缺少任一对应回调时,清理及TEST也不执行;返回ERROR,修正调用环境后再推进。
|
||
* 入口先处理旧期限;调用者直接执行而未先Process,也不能让迟到数据段刷新过期会话。
|
||
*/
|
||
IEC104_FileServiceExecuteResult_t IEC104_FileService_Execute_Next(IEC104_FileService_t *self,
|
||
const IEC104_FileServiceHandlers_t *handlers, void *context);
|
||
/**
|
||
* 功能:DATA不会代替CONTROL交付CLOSE/ABORT/COMMIT;所属事件循环必须继续推进CONTROL以归还资源。
|
||
* 输入参数:self——本模块实例。
|
||
* handlers——回调集合。
|
||
* context——调用方上下文。
|
||
* mode——处理模式。
|
||
* 输出参数:self——本模块实例的更新结果。
|
||
* 返回值:未调用回调的超时推进也返回OK。
|
||
* 说明:CONTROL的OPEN可仅建立快照,需继续有界推进才能形成目录应答;预算耗尽且仍本地就绪时,
|
||
* 应用须登记待准备的级10,避免尚未组帧的目录候选被后续级11/12遗漏。
|
||
* op4提交OK即开始读间隔计时;等待其HANDED仍消耗原期限,不以DATA调度或确认ACK重新起算。
|
||
*/
|
||
IEC104_FileServiceExecuteResult_t IEC104_FileService_Execute_Next_Mode(IEC104_FileService_t *self,
|
||
const IEC104_FileServiceHandlers_t *handlers, void *context, IEC104_FileServiceExecuteMode_t mode);
|
||
/**
|
||
* 功能:只读且回调内允许,失败不修改输出;回调内抑制递归推进提示。
|
||
* 输入参数:self——本模块实例。
|
||
* status——状态快照。
|
||
* 输出参数:status——全部查询成功后写回快照,失败保持原值。
|
||
* 返回值:!Owned(self) || status == NULL || FS_STATUS(self->slave, &transport, NULL) != IEC104_TCP_OK时返回false;其余分支返回false、true。
|
||
* 说明:查询Slave状态失败只报告false,本入口不关闭连接、不触发应用清理、不改变faulted。
|
||
*/
|
||
bool IEC104_FileService_Get_Status(const IEC104_FileService_t *self,
|
||
IEC104_FileServiceStatus_t *status);
|
||
|
||
#ifdef __cplusplus
|
||
}
|
||
#endif
|
||
|
||
#endif /* IEC104_FILE_SERVICE_H */
|