通信协议代码
This commit is contained in:
@@ -0,0 +1,461 @@
|
||||
/*
|
||||
* ASDU层仅处理公共头、对象布局、容量和分派。
|
||||
* 对象编码调用基类函数表;对象解码按Type ID调用独立类型解析器。
|
||||
* 所有外部可见写入都在字段、布局和容量验证完成后提交,失败不留下半条报文。
|
||||
*/
|
||||
#include "IEC60870_Asdu.h"
|
||||
#include "IEC60870_InformationObjects_Internal.h"
|
||||
|
||||
#include <string.h>
|
||||
|
||||
/**
|
||||
* 功能:计算当前配置的ASDU公共头字节数。
|
||||
* 输入参数:parameters——已通过IEC60870_AppLayerParameters_Valid检查的非空参数。
|
||||
* 输出参数:无。
|
||||
* 返回值:2+sizeOfCOT+sizeOfCA,即4、5或6字节。
|
||||
* 说明:固定的2字节是Type ID和VSQ;OA已包含在2字节COT中,不能再次累加。
|
||||
*/
|
||||
static uint16_t Header_Size(const IEC60870_AppLayerParameters_t *parameters)
|
||||
{
|
||||
return (uint16_t)(2 + parameters->sizeOfCOT + parameters->sizeOfCA);
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:检查信息对象区的精确长度、数量、SQ约束及连续地址上限。
|
||||
* 输入参数:info——非空公共头视图,参数和对象原文在使用期间必须有效且不变。
|
||||
* type——与info->type_id匹配的非空只读类型描述。
|
||||
* 输出参数:无。
|
||||
* 返回值:1表示对象区布局合法;0表示参数、数量、长度或隐含地址范围非法。
|
||||
* 说明:先检查长度,再读取首IOA;这里只验证布局,不检查值、品质或时标。
|
||||
*/
|
||||
static int Layout_Valid(const IEC60870_AsduInfo_t *info,
|
||||
const IEC60870_InformationObjectVTable *type)
|
||||
{
|
||||
uint16_t expected;
|
||||
if (!IEC60870_AppLayerParameters_Valid(info->parameters) ||
|
||||
info->information_objects == NULL || info->object_count == 0U ||
|
||||
info->object_count > IEC60870_ASDU_MAX_OBJECTS || info->is_sequence > 1U ||
|
||||
(info->is_sequence && !type->supports_sequence) ||
|
||||
(type->single_object && info->object_count != 1U)) {
|
||||
return 0;
|
||||
}
|
||||
/* 设N为数量、D为值载荷长度、L为IOA宽度:SQ=0占N*(L+D),SQ=1占L+N*D。
|
||||
* 精确相等同时拒绝截短对象和额外尾字节;这里不计ASDU公共头。 */
|
||||
expected = (uint16_t)(info->object_count * type->payload_size +
|
||||
(info->is_sequence ? info->parameters->sizeOfIOA :
|
||||
info->object_count * info->parameters->sizeOfIOA));
|
||||
if (type->get_payload_size_from_buffer != NULL) {
|
||||
uint16_t payload_size;
|
||||
uint16_t address_size = (uint16_t)info->parameters->sizeOfIOA;
|
||||
/* 当前变长类型是单对象文件段;先保护段头读取,再依据LOS计算实际长度。 */
|
||||
if (info->object_count != 1U || info->is_sequence ||
|
||||
info->information_objects_len < address_size) { return 0; }
|
||||
payload_size = type->get_payload_size_from_buffer(info->information_objects + address_size,
|
||||
(uint16_t)(info->information_objects_len - address_size));
|
||||
if (payload_size == 0U) { return 0; }
|
||||
expected = (uint16_t)(address_size + payload_size);
|
||||
}
|
||||
if (expected != info->information_objects_len ||
|
||||
expected > info->parameters->maxSizeOfASDU - Header_Size(info->parameters)) {
|
||||
return 0;
|
||||
}
|
||||
/* SQ首地址本身可表示,但末地址首IOA+N-1也必须能由同样的IOA宽度表示。 */
|
||||
return !info->is_sequence ||
|
||||
IEC60870_Object_Read_LE(info->information_objects, (unsigned int)info->parameters->sizeOfIOA) <=
|
||||
IEC60870_Object_Max_IOA(info->parameters) - (info->object_count - 1U);
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:定位指定对象的值载荷,同时恢复其信息对象地址。
|
||||
* 输入参数:info——已通过Layout_Valid校验的非空ASDU视图。
|
||||
* type——与info->type_id匹配的非空只读类型描述。
|
||||
* index——从0开始的索引,调用方必须保证小于object_count。
|
||||
* 输出参数:ioa——非空地址输出;SQ=1时使用首地址加索引还原。
|
||||
* payload_length——非空输出,返回固定或变长载荷的实际长度。
|
||||
* 返回值:输入原文中的载荷借用指针,不含IOA,不复制字节。
|
||||
* 说明:本内部函数不再验证长度/索引;返回指针的有效期与原ASDU一致。
|
||||
*/
|
||||
static const uint8_t *Element_Position(const IEC60870_AsduInfo_t *info,
|
||||
const IEC60870_InformationObjectVTable *type, uint8_t index, uint32_t *ioa,
|
||||
uint16_t *payload_length)
|
||||
{
|
||||
unsigned int address_size = (unsigned int)info->parameters->sizeOfIOA;
|
||||
const uint8_t *data = info->information_objects;
|
||||
*payload_length = type->payload_size;
|
||||
if (type->get_payload_size_from_buffer != NULL) {
|
||||
/* Layout_Valid已确认变长对象为SQ=0、数量1且载荷完整。 */
|
||||
*payload_length = type->get_payload_size_from_buffer(data + address_size,
|
||||
(uint16_t)(info->information_objects_len - address_size));
|
||||
}
|
||||
/* SQ=1的对象区为:首IOA、载荷0、载荷1……;后续地址不占报文字节。 */
|
||||
if (info->is_sequence) {
|
||||
*ioa = IEC60870_Object_Read_LE(data, address_size) + index;
|
||||
return data + address_size + index * type->payload_size;
|
||||
}
|
||||
/* SQ=0每个对象都有独立IOA,故步长包含地址;取值前先跳过该地址。 */
|
||||
data += index * (address_size + type->payload_size);
|
||||
*ioa = IEC60870_Object_Read_LE(data, address_size);
|
||||
return data + address_size;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:核对容器控制字段与已构造ASDU布局是否一致。
|
||||
* 输入参数:self——待检查容器或借用原文对象,可为NULL。
|
||||
* 输出参数:无。
|
||||
* 返回值:1表示结构状态一致;0表示参数、容量、类型、数量、长度或首地址非法。
|
||||
* 说明:构造容器按类型重算精确长度;借用原文对象只检查公共头及最低长度。
|
||||
* 不重新解码值,参数、控制字段及对象区须由调用方保持有效且不变。
|
||||
*/
|
||||
static int Container_Valid(const IEC60870_Asdu_t *self)
|
||||
{
|
||||
uint16_t expected;
|
||||
const IEC60870_InformationObjectVTable *type;
|
||||
if (self == NULL || self->buffer == NULL ||
|
||||
!IEC60870_AppLayerParameters_Valid(self->parameters) ||
|
||||
self->capacity < Header_Size(self->parameters) ||
|
||||
self->capacity > self->parameters->maxSizeOfASDU ||
|
||||
self->length < Header_Size(self->parameters) ||
|
||||
self->length > self->capacity || self->is_sequence > 1U ||
|
||||
self->object_count > IEC60870_ASDU_MAX_OBJECTS || self->is_from_buffer > 1U) {
|
||||
return 0;
|
||||
}
|
||||
if (self->is_from_buffer) {
|
||||
IEC60870_AsduInfo_t info;
|
||||
/* 已有原文的容量固定为其长度,不将未知对象当作可追加的构造容器。
|
||||
* 不读取未知类型的IOA;first_ioa仅供构造时的连续地址检查使用。 */
|
||||
return self->capacity == self->length && self->first_ioa == 0U &&
|
||||
IEC60870_Parse_ASDU_Header(self->parameters, self->buffer, self->length, &info) &&
|
||||
self->type_id == info.type_id && self->object_count == info.object_count &&
|
||||
self->is_sequence == info.is_sequence;
|
||||
}
|
||||
expected = Header_Size(self->parameters);
|
||||
if (self->object_count == 0U) {
|
||||
if (self->type_id != 0U) { return 0; }
|
||||
} else {
|
||||
type = IEC60870_InformationObject_Get_Descriptor(self->type_id);
|
||||
if (type == NULL || (self->is_sequence && !type->supports_sequence) ||
|
||||
(type->single_object && self->object_count != 1U)) {
|
||||
return 0;
|
||||
}
|
||||
expected = (uint16_t)(expected + self->object_count * type->payload_size +
|
||||
(self->is_sequence ? self->parameters->sizeOfIOA :
|
||||
self->object_count * self->parameters->sizeOfIOA));
|
||||
if (type->get_payload_size_from_buffer != NULL) {
|
||||
IEC60870_AsduInfo_t info;
|
||||
if (!IEC60870_Parse_ASDU_Header(self->parameters, self->buffer, self->length, &info) ||
|
||||
!Layout_Valid(&info, type)) { return 0; }
|
||||
expected = self->length;
|
||||
}
|
||||
}
|
||||
if (self->length != expected || self->buffer[0] != self->type_id ||
|
||||
self->buffer[1] != (uint8_t)(self->object_count | (self->is_sequence << 7))) {
|
||||
return 0;
|
||||
}
|
||||
if (self->object_count != 0U &&
|
||||
(self->first_ioa != IEC60870_Object_Read_LE(self->buffer + Header_Size(self->parameters),
|
||||
(unsigned int)self->parameters->sizeOfIOA) ||
|
||||
(self->is_sequence && self->first_ioa >
|
||||
IEC60870_Object_Max_IOA(self->parameters) - (self->object_count - 1U)))) {
|
||||
return 0;
|
||||
}
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:在调用方缓冲区中创建一个尚未加入对象的ASDU。
|
||||
* 输入参数:parameters——非空合法参数;容器借用指针,使用期间必须有效且不变。
|
||||
* capacity——buffer实际可用字节数;有效容量取此值与maxSizeOfASDU的较小值。
|
||||
* header——非空公共头配置;COT为0..63,P/N和TEST为0/1,CA须适合所选宽度。
|
||||
* is_sequence——0为逐对象IOA,1为连续地址;一条ASDU内不自动切换。
|
||||
* 输出参数:self——非空容器存储,成功后记录缓冲区、参数及初始状态。
|
||||
* buffer——非空可写ASDU缓冲区,初始只写公共头,不含APCI。
|
||||
* 返回值:OK为成功,FULL为实际缓冲区不足头长,ERROR为参数或字段非法。
|
||||
* 说明:全部检查通过后才写回;首对象尚未确定,Type ID和对象数均为0。
|
||||
* 本函数不分配内存,也不发送;SQ适用性按具体类型检查,空容器不能Get_Data。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Create(IEC60870_Asdu_t *self,
|
||||
const IEC60870_AppLayerParameters_t *parameters,
|
||||
uint8_t *buffer, uint16_t capacity, const IEC60870_AsduHeader_t *header, int is_sequence)
|
||||
{
|
||||
IEC60870_Asdu_t result;
|
||||
uint16_t header_length;
|
||||
if (self == NULL || buffer == NULL || header == NULL ||
|
||||
!IEC60870_AppLayerParameters_Valid(parameters) ||
|
||||
(is_sequence != 0 && is_sequence != 1) ||
|
||||
header->cause_of_transmission > 63U || header->is_negative_confirm > 1U ||
|
||||
header->is_test > 1U || (parameters->sizeOfCA == 1 && header->common_address > 255U)) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
header_length = Header_Size(parameters);
|
||||
if (capacity < header_length) { return IEC60870_ASDU_FULL; }
|
||||
memset(&result, 0, sizeof(result));
|
||||
result.buffer = buffer;
|
||||
/* 缓冲区较大也不能突破协议配置上限;仅保存参数指针,不复制配置。 */
|
||||
result.capacity = capacity > parameters->maxSizeOfASDU ?
|
||||
(uint16_t)parameters->maxSizeOfASDU : capacity;
|
||||
result.length = header_length;
|
||||
result.is_sequence = (uint8_t)is_sequence;
|
||||
result.parameters = parameters;
|
||||
/* 此后没有可能失败的校验;按所选宽度恰好写入header_length字节。 */
|
||||
/* Type ID暂置0;VSQ bit7为SQ、低7位为数量,初始数量为0。 */
|
||||
buffer[0] = 0;
|
||||
buffer[1] = (uint8_t)(is_sequence << 7);
|
||||
/* COT首字节:bit0..5为原因、bit6为P/N、bit7为TEST;2字节COT才写OA。 */
|
||||
buffer[2] = (uint8_t)(header->cause_of_transmission |
|
||||
(header->is_negative_confirm << 6) | (header->is_test << 7));
|
||||
if (parameters->sizeOfCOT == 2) { buffer[3] = header->originator_address; }
|
||||
IEC60870_Object_Write_LE(buffer + 2 + parameters->sizeOfCOT,
|
||||
header->common_address, (unsigned int)parameters->sizeOfCA);
|
||||
*self = result;
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:将已有可写ASDU原文包装成调用方持有的对象。
|
||||
* 输入参数:parameters——非空应用层参数;buffer——可写原文;length——原文长度。
|
||||
* 输出参数:self——全部检查成功后写入;buffer不变。
|
||||
* 返回值:OK为成功,ERROR为参数或最低长度非法。
|
||||
* 说明:借用参数和原文,不分配、不复制;本入口不替代业务使用的完整Parse。
|
||||
* 容量固定为原文长度,后续只允许修改公共头,不能追加信息对象。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Create_From_Buffer(IEC60870_Asdu_t *self,
|
||||
const IEC60870_AppLayerParameters_t *parameters, uint8_t *buffer, uint16_t length)
|
||||
{
|
||||
IEC60870_AsduInfo_t info;
|
||||
IEC60870_Asdu_t result;
|
||||
if (self == NULL || !IEC60870_Parse_ASDU_Header(parameters, buffer, length, &info)) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
memset(&result, 0, sizeof(result));
|
||||
result.buffer = buffer;
|
||||
result.capacity = length;
|
||||
result.length = length;
|
||||
result.type_id = info.type_id;
|
||||
result.object_count = info.object_count;
|
||||
result.is_sequence = info.is_sequence;
|
||||
result.is_from_buffer = 1U;
|
||||
result.parameters = parameters;
|
||||
*self = result;
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:修改ASDU传送原因,保留COT字节中的两个独立标志。
|
||||
* 输入参数:self——合法ASDU对象;cause——0..63。
|
||||
* 输出参数:self->buffer[2]——校验成功后更新低6位。
|
||||
* 返回值:OK为成功,ERROR为参数或对象状态非法。
|
||||
* 说明:所有字段宽度配置中COT首字节均位于偏移2;不改变OA或载荷。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Set_COT(IEC60870_Asdu_t *self, int cause)
|
||||
{
|
||||
if (cause < 0 || cause > 63 || !Container_Valid(self)) { return IEC60870_ASDU_ERROR; }
|
||||
self->buffer[2] = (uint8_t)((self->buffer[2] & 0xC0U) | (uint8_t)cause);
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:修改ASDU的P/N标志,保留传送原因及TEST。
|
||||
* 输入参数:self——合法ASDU对象;is_negative——0或1。
|
||||
* 输出参数:self->buffer[2]——校验成功后仅更新bit6。
|
||||
* 返回值:OK为成功,ERROR为参数或对象状态非法。
|
||||
* 说明:不执行命令,不提交发送;失败保持字节原值。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Set_Negative(IEC60870_Asdu_t *self, int is_negative)
|
||||
{
|
||||
if ((is_negative != 0 && is_negative != 1) || !Container_Valid(self)) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
self->buffer[2] = (uint8_t)((self->buffer[2] & 0xBFU) | (uint8_t)(is_negative << 6));
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:修改ASDU公共地址,保留其他公共头字段与对象区。
|
||||
* 输入参数:self——合法ASDU对象;common_address——须适合sizeOfCA的无符号地址。
|
||||
* 输出参数:self->buffer——在2+sizeOfCOT偏移按小端写入sizeOfCA字节。
|
||||
* 返回值:OK为成功,ERROR为非法容器或1字节CA无法表示的地址;失败不写入。
|
||||
* 说明:沿用Container_Valid检查构造及借用对象,不截断地址,不决定是否允许广播。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Set_CA(IEC60870_Asdu_t *self, uint16_t common_address)
|
||||
{
|
||||
if (!Container_Valid(self) || (self->parameters->sizeOfCA == 1 && common_address > 255U)) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
IEC60870_Object_Write_LE(self->buffer + 2 + self->parameters->sizeOfCOT,
|
||||
common_address, (unsigned int)self->parameters->sizeOfCA);
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:编码并追加一个同类型对象,成功后更新ASDU长度及VSQ。
|
||||
* 输入参数:self——已成功Create且控制字段/参数/原文未被修改的容器。
|
||||
* object——已由具体类型Create或解析器初始化的公共基类首成员。
|
||||
* 输出参数:self——成功后更新容器及其字节缓冲区,失败保持原值。
|
||||
* 返回值:OK为追加成功;FULL为字节空间或对象数已满;UNSUPPORTED为未知类型;
|
||||
* ERROR为容器、身份、字段、地址或SQ约束非法。
|
||||
* 说明:在有界临时区完成IOA和值编码(含变长文件段),确认容量后才写入。
|
||||
* 首个成功对象固定Type ID;SQ=1首对象仍带IOA,其后只写载荷且地址必须递增1。
|
||||
* FULL时由调用方提交已有非空ASDU,另起一条重试同一对象;不会自动拆包。
|
||||
* 成功后仅保存对象的报文字节,不借用object,调用方可以立即复用其存储。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Add_InformationObject(IEC60870_Asdu_t *self,
|
||||
const IEC60870_InformationObject_t *object)
|
||||
{
|
||||
const IEC60870_InformationObjectVTable *type;
|
||||
uint8_t encoded[IEC60870_OBJECT_MAX_ENCODED];
|
||||
uint16_t added;
|
||||
IEC60870_AsduResult_t status;
|
||||
if (!Container_Valid(self) || self->is_from_buffer || object == NULL) { return IEC60870_ASDU_ERROR; }
|
||||
type = IEC60870_InformationObject_Get_Descriptor(object->type_id);
|
||||
if (type == NULL) { return IEC60870_ASDU_UNSUPPORTED; }
|
||||
if (object->virtual_function_table != type ||
|
||||
(self->object_count != 0U && self->type_id != type->type_id) ||
|
||||
(self->is_sequence && !type->supports_sequence) ||
|
||||
object->ioa > IEC60870_Object_Max_IOA(self->parameters)) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
/* 用减法先判断地址范围,再比较首IOA+已有数量,避免允许隐含地址越界。 */
|
||||
if (self->is_sequence && self->object_count != 0U &&
|
||||
(self->first_ioa > IEC60870_Object_Max_IOA(self->parameters) - self->object_count ||
|
||||
object->ioa != self->first_ioa + self->object_count)) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
/* 字段错误优先于容量已满,以免把非法对象误当作下一条ASDU的可重试输入。 */
|
||||
status = IEC60870_InformationObject_Encode(object, self->parameters,
|
||||
self->is_sequence && self->object_count != 0U, encoded, sizeof(encoded), &added);
|
||||
if (status != IEC60870_ASDU_OK) { return status; }
|
||||
if (self->object_count == IEC60870_ASDU_MAX_OBJECTS ||
|
||||
(type->single_object && self->object_count != 0U) ||
|
||||
added > self->capacity - self->length) {
|
||||
return IEC60870_ASDU_FULL;
|
||||
}
|
||||
/* 从此处开始统一提交,没有后续失败分支,容量不足不会留下半个对象。 */
|
||||
memcpy(self->buffer + self->length, encoded, added);
|
||||
if (self->object_count == 0U) {
|
||||
self->first_ioa = object->ioa;
|
||||
self->type_id = type->type_id;
|
||||
self->buffer[0] = type->type_id;
|
||||
}
|
||||
self->length = (uint16_t)(self->length + added);
|
||||
++self->object_count;
|
||||
self->buffer[1] = (uint8_t)(self->object_count | (self->is_sequence << 7));
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:导出构造完成或直接借用的ASDU原文。
|
||||
* 输入参数:self——非空合法对象;Create创建的容器必须至少加入一个对象。
|
||||
* 输出参数:asdu——非空输出指针,成功时指向调用方原有缓冲区。
|
||||
* length——非空输出指针,成功时得到当前ASDU字节数,不含APCI。
|
||||
* 返回值:OK为成功;ERROR为容器、输出参数非法或容器为空;失败不修改输出。
|
||||
* 说明:返回借用视图,不复制或发送。借用原文对象不额外进行完整对象校验。
|
||||
* 后续Add/Create/Set会影响原文,length只是本次快照。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Get_Data(const IEC60870_Asdu_t *self,
|
||||
const uint8_t **asdu, uint16_t *length)
|
||||
{
|
||||
if (!Container_Valid(self) || (!self->is_from_buffer && self->object_count == 0U) ||
|
||||
asdu == NULL || length == NULL) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
*asdu = self->buffer;
|
||||
*length = self->length;
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:校验完整ASDU(含参数和文件类型),生成可用于逐对象提取的只读视图。
|
||||
* 输入参数:parameters——显式非空应用层参数,字段宽度必须对应收到的报文。
|
||||
* asdu——非空ASDU原文,不含APCI。
|
||||
* length——完整ASDU字节数,不能超过配置上限,不能包含多余尾字节。
|
||||
* 输出参数:info——非空视图输出,借用parameters和asdu,二者须在取对象期间有效且不变。
|
||||
* 返回值:OK为成功;UNSUPPORTED为未支持类型;ERROR为公共头、布局或任一对象非法。
|
||||
* 说明:先检查公共头和布局,再验证所有对象,全部成功后才发布info,失败保留旧输出。
|
||||
* 不执行命令,也不判断COT/CA/IOA的业务适用性;具体对象通过Get_Element获取。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Parse(const IEC60870_AppLayerParameters_t *parameters,
|
||||
const uint8_t *asdu, uint16_t length, IEC60870_AsduInfo_t *info)
|
||||
{
|
||||
IEC60870_AsduInfo_t result;
|
||||
const IEC60870_InformationObjectVTable *type;
|
||||
uint8_t i;
|
||||
if (info == NULL || !IEC60870_Parse_ASDU_Header(parameters, asdu, length, &result)) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
type = IEC60870_InformationObject_Get_Descriptor(result.type_id);
|
||||
if (type == NULL) { return IEC60870_ASDU_UNSUPPORTED; }
|
||||
if (!Layout_Valid(&result, type)) { return IEC60870_ASDU_ERROR; }
|
||||
/* 输出传NULL使类型解析器仅校验,不分配对象数组;任一对象失败就丢弃整个临时视图。 */
|
||||
for (i = 0; i < result.object_count; ++i) {
|
||||
uint32_t ioa;
|
||||
uint16_t payload_length;
|
||||
const uint8_t *payload = Element_Position(&result, type, i, &ioa, &payload_length);
|
||||
IEC60870_AsduResult_t status = IEC60870_InformationObject_Decode(result.type_id, ioa,
|
||||
payload, payload_length, NULL, 0);
|
||||
if (status != IEC60870_ASDU_OK) { return status; }
|
||||
}
|
||||
*info = result;
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:从已解析视图中按索引取得一个独立类型的对象副本。
|
||||
* 输入参数:info——由Asdu_Parse生成且未修改的视图,其原文和参数仍须有效。
|
||||
* index——从0开始的对象索引,必须小于object_count。
|
||||
* object_size——object实际可用字节数,至少为对应具体结构的sizeof。
|
||||
* 输出参数:object——非空具体对象存储,结构类型必须由info->type_id正确选择。
|
||||
* 返回值:OK为成功;UNSUPPORTED为未知类型;ERROR为布局、索引、载荷或输出尺寸非法。
|
||||
* 说明:输出无需预先Create,成功时按值保存且不借用原文,失败保持原输出不变。
|
||||
* 只重新检查布局和选中对象;尺寸校验不能替代C语言类型匹配,公共头仍从info读取。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Get_Element(const IEC60870_AsduInfo_t *info,
|
||||
uint8_t index, void *object, size_t object_size)
|
||||
{
|
||||
const IEC60870_InformationObjectVTable *type;
|
||||
const uint8_t *payload;
|
||||
uint32_t ioa;
|
||||
uint16_t payload_length;
|
||||
if (info == NULL || object == NULL) { return IEC60870_ASDU_ERROR; }
|
||||
type = IEC60870_InformationObject_Get_Descriptor(info->type_id);
|
||||
if (type == NULL) { return IEC60870_ASDU_UNSUPPORTED; }
|
||||
if (!Layout_Valid(info, type) || index >= info->object_count) { return IEC60870_ASDU_ERROR; }
|
||||
payload = Element_Position(info, type, index, &ioa, &payload_length);
|
||||
return IEC60870_InformationObject_Decode(info->type_id, ioa, payload,
|
||||
payload_length, object, object_size);
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:复制请求原文并改写COT/P/N,构造确认、终止或未知字段错误应答。
|
||||
* 输入参数:parameters——与请求布局匹配的非空合法应用层参数。
|
||||
* request——非空请求ASDU原文,不含APCI。
|
||||
* length——请求ASDU的完整字节数。
|
||||
* cause——接受7、9、10及44..47;分别用于确认、终止及未知类型/原因/地址。
|
||||
* is_negative——P/N标志,0或1;否定激活确认使用cause=7、is_negative=1。
|
||||
* capacity——out实际可写字节数,至少为length。
|
||||
* 输出参数:out——非空应答缓冲区,可与request原地或部分重叠。
|
||||
* out_length——非空长度输出,成功时等于length。
|
||||
* 返回值:OK为成功,FULL为输出容量不足,ERROR为参数或请求基础格式非法。
|
||||
* 说明:只依赖公共头和最低长度检查,不要求具体对象解析成功,因此可回显未知类型。
|
||||
* 保留TEST、OA、CA、VSQ及所有对象字节;失败不修改out/out_length,不自动发送。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Build_Response(const IEC60870_AppLayerParameters_t *parameters,
|
||||
const uint8_t *request, uint16_t length,
|
||||
int cause, int is_negative, uint8_t *out, uint16_t capacity, uint16_t *out_length)
|
||||
{
|
||||
IEC60870_AsduInfo_t info;
|
||||
uint8_t cot;
|
||||
if (out == NULL || out_length == NULL || (is_negative != 0 && is_negative != 1) ||
|
||||
(cause != IEC60870_ASDU_COT_ACTIVATION_CON && cause != IEC60870_ASDU_COT_DEACTIVATION_CON &&
|
||||
cause != IEC60870_ASDU_COT_ACTIVATION_TERMINATION &&
|
||||
(cause < IEC60870_ASDU_COT_UNKNOWN_TYPE || cause > IEC60870_ASDU_COT_UNKNOWN_IOA)) ||
|
||||
!IEC60870_Parse_ASDU_Header(parameters, request, length, &info)) {
|
||||
return IEC60870_ASDU_ERROR;
|
||||
}
|
||||
if (capacity < length) { return IEC60870_ASDU_FULL; }
|
||||
/* 先保存新COT,再memmove原文;即使输入输出重叠,也不会丢失请求的TEST。 */
|
||||
cot = (uint8_t)(cause | (is_negative << 6) | (info.is_test << 7));
|
||||
memmove(out, request, length);
|
||||
out[2] = cot;
|
||||
*out_length = length;
|
||||
return IEC60870_ASDU_OK;
|
||||
}
|
||||
@@ -0,0 +1,163 @@
|
||||
/*
|
||||
* 101/104共用ASDU容器。公共头、VSQ/SQ、容量、IOA布局由本层维护,
|
||||
* 数值、品质、命令限定词和时标的编解码由具体信息对象完成。
|
||||
* 参数与字节缓冲区均由调用方提供;无动态内存或可变全局状态。
|
||||
*
|
||||
* 发送:具体类型Create -> Asdu_Create -> Add_InformationObject(逐个)-> Get_Data。
|
||||
* 接收:Asdu_Parse -> 按info.type_id选择具体结构 -> Get_Element。
|
||||
* Type ID决定载荷格式,COT表示传送原因,CA是站公共地址,IOA是点/对象地址;
|
||||
* VSQ低7位是对象数,bit7是SQ。SQ=1只保存首IOA,随后各对象地址依次加1。
|
||||
*/
|
||||
#ifndef IEC60870_ASDU_H
|
||||
#define IEC60870_ASDU_H
|
||||
|
||||
#include "IEC60870_Codec.h"
|
||||
#include "IEC60870_InformationObjects.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* COT首字节的低6位,不含独立的P/N和TEST标志;不是完整的COT适用规则表。 */
|
||||
typedef enum {
|
||||
IEC60870_ASDU_COT_PERIODIC = 1, /* 周期/循环上报。 */
|
||||
IEC60870_ASDU_COT_BACKGROUND = 2, /* 背景扫描。 */
|
||||
IEC60870_ASDU_COT_SPONTANEOUS = 3, /* 突发上报。 */
|
||||
IEC60870_ASDU_COT_INITIALIZED = 4, /* 初始化结束。 */
|
||||
IEC60870_ASDU_COT_REQUEST = 5, /* 请求或被请求的数据。 */
|
||||
IEC60870_ASDU_COT_ACTIVATION = 6, /* 激活请求。 */
|
||||
IEC60870_ASDU_COT_ACTIVATION_CON = 7, /* 激活确认,P/N另行指定。 */
|
||||
IEC60870_ASDU_COT_DEACTIVATION = 8, /* 停止激活请求。 */
|
||||
IEC60870_ASDU_COT_DEACTIVATION_CON = 9, /* 停止激活确认。 */
|
||||
IEC60870_ASDU_COT_ACTIVATION_TERMINATION = 10, /* 激活终止。 */
|
||||
IEC60870_ASDU_COT_FILE_TRANSFER = 13, /* 文件传输。 */
|
||||
IEC60870_ASDU_COT_INTERROGATED_BY_STATION = 20, /* 响应站总召唤的数据。 */
|
||||
IEC60870_ASDU_COT_COUNTER_INTERROGATION = 37, /* 响应电能脉冲总召唤的数据。 */
|
||||
IEC60870_ASDU_COT_UNKNOWN_TYPE = 44, /* 未知类型标识。 */
|
||||
IEC60870_ASDU_COT_UNKNOWN_CAUSE = 45, /* 未知传送原因。 */
|
||||
IEC60870_ASDU_COT_UNKNOWN_COMMON_ADDRESS = 46, /* 未知公共地址。 */
|
||||
IEC60870_ASDU_COT_UNKNOWN_IOA = 47 /* 未知信息对象地址。 */
|
||||
} IEC60870_AsduCause_t;
|
||||
|
||||
/* 创建ASDU时仅提供公共头;Type ID由首个成功添加的对象决定,VSQ由容器维护。
|
||||
* 字段赋值前不得截窄越界整数。COT/CA/IOA的业务适用性由应用层检查。 */
|
||||
typedef struct {
|
||||
uint8_t cause_of_transmission; /* COT低6位,0..63,不含P/N及TEST。 */
|
||||
uint8_t is_negative_confirm; /* P/N:0肯定、1否定。 */
|
||||
uint8_t is_test; /* TEST:0/1。 */
|
||||
uint8_t originator_address; /* 显式OA;COT为1字节时忽略,解析输出0。 */
|
||||
uint16_t common_address; /* 1字节CA拒绝超过255的值,不截断。 */
|
||||
} IEC60870_AsduHeader_t;
|
||||
|
||||
/* 调用方保存的容器;控制字段由Create/Create_From_Buffer初始化,不得手工修改。
|
||||
* 字节区通过Add或字段设置接口修改;parameters在使用期间必须有效且不变。
|
||||
* Create_From_Buffer借用可写原文,只允许设置公共头,不允许继续追加对象。
|
||||
* 同一实例由调用方串行使用;对象不分配或释放其借用的缓冲区。 */
|
||||
typedef struct {
|
||||
uint8_t *buffer; /* ASDU原文,不含APCI。 */
|
||||
uint16_t capacity; /* min(调用方容量, maxSizeOfASDU)。 */
|
||||
uint16_t length; /* 当前字节数,空容器仅有公共头。 */
|
||||
uint8_t type_id; /* 空容器为0,首个对象成功加入后固定。 */
|
||||
uint8_t object_count; /* 按类型限制为0..127或0..1;借用时记录原VSQ数量。 */
|
||||
uint8_t is_sequence; /* SQ:0逐对象地址,1连续地址。 */
|
||||
uint8_t is_from_buffer;/* 1为借用收到的原文;0为Create创建的构造容器。 */
|
||||
uint32_t first_ioa; /* 构造时供SQ连续性校验;借用原文时为0且不使用。 */
|
||||
const IEC60870_AppLayerParameters_t *parameters; /* 借用参数,不复制。 */
|
||||
} IEC60870_Asdu_t;
|
||||
|
||||
/* 结果须显式比较IEC60870_ASDU_OK;FULL=0,ERROR/UNSUPPORTED为负值。
|
||||
* 所有失败保留调用方输出。结构体、输出参数和字节区不得互相重叠;
|
||||
* 唯一例外是Build_Response允许输入/输出字节区重叠。 */
|
||||
|
||||
/* 创建空容器并固定参数、SQ和公共头;参数必须非空,头长=2+COT宽度+CA宽度。
|
||||
* 有效容量不足头长返回FULL;SQ=1只适用于监视信息和文件目录。
|
||||
* 初始Type ID为0,首个对象失败不会改变类型;空容器不能Get_Data。 */
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Create(IEC60870_Asdu_t *self,
|
||||
const IEC60870_AppLayerParameters_t *parameters,
|
||||
uint8_t *buffer, uint16_t capacity, const IEC60870_AsduHeader_t *header, int is_sequence);
|
||||
|
||||
/**
|
||||
* 功能:在调用方存储中建立可修改的ASDU对象,直接借用已有报文字节。
|
||||
* 输入参数:parameters——对应原文布局的非空合法参数,使用期间有效且不变。
|
||||
* buffer——非空可写ASDU原文,不含APCI;length——原文完整长度。
|
||||
* 输出参数:self——成功时写入容器,失败保持原值;buffer不变。
|
||||
* 返回值:OK为成功,ERROR为参数或最低长度非法。
|
||||
* 说明:只检查公共头和已知类型最低长度,允许未知类型回显错误应答。
|
||||
* 业务执行前仍应调用Parse进行完整校验;不复制、不分配、不追加对象。
|
||||
* 字段设置会修改buffer;必须保证buffer和parameters在使用期间有效。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Create_From_Buffer(IEC60870_Asdu_t *self,
|
||||
const IEC60870_AppLayerParameters_t *parameters, uint8_t *buffer, uint16_t length);
|
||||
|
||||
/**
|
||||
* 功能:原地设置ASDU的传送原因。
|
||||
* 输入参数:self——合法构造容器或借用原文的对象;cause——0..63。
|
||||
* 输出参数:self->buffer——仅更新COT低6位,保留P/N、TEST及其余字节。
|
||||
* 返回值:OK为成功,ERROR为参数非法;失败不修改原文。
|
||||
* 说明:不判断传送原因的业务适用性,也不发送报文。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Set_COT(IEC60870_Asdu_t *self, int cause);
|
||||
|
||||
/**
|
||||
* 功能:原地设置ASDU的肯定或否定确认标志。
|
||||
* 输入参数:self——合法ASDU对象;is_negative——0肯定、1否定。
|
||||
* 输出参数:self->buffer——仅更新P/N位,保留COT、TEST及其余字节。
|
||||
* 返回值:OK为成功,ERROR为参数非法;失败不修改原文。
|
||||
* 说明:设置字段不代表业务已接受命令,也不提交发送。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Set_Negative(IEC60870_Asdu_t *self, int is_negative);
|
||||
|
||||
/**
|
||||
* 功能:原地设置ASDU公共地址,适用于合法构造容器或借用可写原文的对象。
|
||||
* 输入参数:self——合法ASDU对象;common_address——0..65535,须适合配置的CA宽度。
|
||||
* 输出参数:self->buffer——仅更新CA字段,按小端序写入1或2字节。
|
||||
* 返回值:OK为成功,ERROR为对象状态或字段宽度非法;失败不修改任何原文字节。
|
||||
* 说明:偏移由COT宽度确定,保留OA、TEST、P/N及对象原文;不限制业务上的站地址范围。
|
||||
* 不分配、不改变容器长度、不发送;原文修改后,旧解析视图须重新解析。
|
||||
*/
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Set_CA(IEC60870_Asdu_t *self, uint16_t common_address);
|
||||
|
||||
/* 通过对象函数表编码并复制到ASDU,成功后不再借用对象本身。
|
||||
* 单类型约束、SQ连续地址和IOA宽度统一检查。字节容量不足、对象达到127个,
|
||||
* 或单对象类型已加入对象时返回FULL;类型不匹配、SQ或字段非法返回ERROR。
|
||||
* FULL时由调用方提交当前非空ASDU,另起一条重试同一对象,不自动发送或拆包。 */
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Add_InformationObject(IEC60870_Asdu_t *self,
|
||||
const IEC60870_InformationObject_t *object);
|
||||
|
||||
/* 获取构造容器或Create_From_Buffer对象的借用原文及当前长度。
|
||||
* Create创建的空容器不可导出;借用原文对象沿用公共头最低长度检查。
|
||||
* 不分配、不复制、不发送;需完整检查对象值时先调用Parse。
|
||||
* 缓冲区修改后原视图失效;提交104传输时应使用2/2/3配置及<=249的总长。 */
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Get_Data(const IEC60870_Asdu_t *self,
|
||||
const uint8_t **asdu, uint16_t *length);
|
||||
|
||||
/* 统一解析67种监视、命令、初始化结束、参数和文件类型。
|
||||
* 验证精确长度和所有对象,文件段按LOS检查变长载荷。
|
||||
* 监视与文件目录支持SQ=0/1;参数允许多个对象但要求SQ=0。
|
||||
* 其余类型要求SQ=0、数量=1;未知类型返回UNSUPPORTED。
|
||||
* info借用参数和输入原文,二者在取对象期间均须有效且不变。 */
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Parse(const IEC60870_AppLayerParameters_t *parameters,
|
||||
const uint8_t *asdu, uint16_t length, IEC60870_AsduInfo_t *info);
|
||||
|
||||
/* 按Type ID调用具体解析器,向对应类型的存储写入一个按值对象。
|
||||
* 例如Type 1传入&point、sizeof(point),其中point为IEC60870_SinglePointInformation_t。
|
||||
* 调用方必须依据info->type_id选择正确的结构类型;object_size至少为该结构尺寸,
|
||||
* 尺寸检查不能替代C语言中的类型匹配。index从0开始,输出无需预先Create。
|
||||
* 对象不借用原文;公共头继续从info读取,选中对象之外不再次重复解码。 */
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Get_Element(const IEC60870_AsduInfo_t *info,
|
||||
uint8_t index, void *object, size_t object_size);
|
||||
|
||||
/* 复制请求,只更新COT及P/N,保留TEST、OA、CA、VSQ和对象原文。
|
||||
* cause接受7/9/10/44..47,is_negative为0/1;否定激活确认传7、1。
|
||||
* 仅检查公共头及最低长度,允许未知类型回显,不要求对象解析成功。
|
||||
* 参数须对应请求布局。容量不足返回FULL,所有失败保留out及out_length。
|
||||
* 输入/输出字节区支持原地与部分重叠;不执行命令或自动发送。 */
|
||||
IEC60870_AsduResult_t IEC60870_Asdu_Build_Response(const IEC60870_AppLayerParameters_t *parameters,
|
||||
const uint8_t *request, uint16_t length,
|
||||
int cause, int is_negative, uint8_t *out, uint16_t capacity, uint16_t *out_length);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* IEC60870_ASDU_H */
|
||||
@@ -0,0 +1,204 @@
|
||||
/*
|
||||
* IEC 60870-5-101/104 共用时间源实现:读取当前日历、设置实际时钟。
|
||||
* IEC60870_CLOCK_USE_RTC=0 使用本文件内的 Windows 读写,=1 调用 RTC 预留接口。
|
||||
* 公共入口统一使用固定 UTC+8 标准时间,检查日历、读取质量并重算星期。
|
||||
* Windows 分支负责 UTC 与 UTC+8 的转换,不使用计算机配置的本地时区或夏令时。
|
||||
* RTC 分支直接收发约定的 UTC+8 日历;芯片初始化、寄存器读写由板级驱动负责。
|
||||
*/
|
||||
#include "IEC60870_Clock.h"
|
||||
|
||||
/* 编译时选择时间源;RTC 模式不编译下面的 Windows 实现,也不包含 windows.h。 */
|
||||
#if !IEC60870_CLOCK_USE_RTC
|
||||
|
||||
#ifndef _WIN32
|
||||
#error "Windows clock requires _WIN32; define IEC60870_CLOCK_USE_RTC=1 for RTC"
|
||||
#else
|
||||
|
||||
#ifndef WIN32_LEAN_AND_MEAN
|
||||
#define WIN32_LEAN_AND_MEAN
|
||||
#endif
|
||||
#include <windows.h>
|
||||
|
||||
/*
|
||||
* 函数功能:在日历数值上加减固定八小时,完成 UTC 与 UTC+8 标准时间的转换。
|
||||
* 入口参数:source——源日历;to_local——非 0 表示 UTC 加八小时,0 表示 UTC+8 减八小时。
|
||||
* 出口参数:result——转换后的日历,仅返回成功时可使用;两个指针均由内部调用方保证非空。
|
||||
* 返回值:1 转换成功;0 Windows 日期转换失败,或加减偏移会使中间计数溢出。
|
||||
* 说明:FILETIME 以 100 纳秒为单位,从 1601-01-01 起计数;此处只用它进行日期运算。
|
||||
* 本地日历也按字段数值展开,平移后的中间计数不作为 UTC 时间戳对外返回。
|
||||
* 加减后交给 Windows 还原年月日,自然处理跨日、跨月、跨年及闰日。
|
||||
* 1970..2099 的业务日历范围由读写入口检查,本函数不额外限制年份。
|
||||
*/
|
||||
static int Shift_Calendar(const SYSTEMTIME *source, int to_local, SYSTEMTIME *result)
|
||||
{
|
||||
/* 分钟数 × 每分钟秒数 × 每秒 100 纳秒单位数;先转为 64 位再乘,避免中间结果溢出。 */
|
||||
const uint64_t offset_ticks = (uint64_t)IEC60870_LOCAL_UTC_OFFSET_MINUTES *
|
||||
UINT64_C(60) * UINT64_C(10000000);
|
||||
FILETIME encoded;
|
||||
uint64_t ticks;
|
||||
|
||||
/* 只展开日历数值,不查询系统本地时区;转换失败时不使用 encoded。 */
|
||||
if (!SystemTimeToFileTime(source, &encoded)) {
|
||||
return 0;
|
||||
}
|
||||
/* FILETIME 分为高、低两个 32 位字段,按位组合可避免指针强转带来的对齐和别名问题。 */
|
||||
ticks = ((uint64_t)encoded.dwHighDateTime << 32) | encoded.dwLowDateTime;
|
||||
if (to_local != 0) {
|
||||
/* 先检查再加,防止无符号整数回绕为较小的时间值。 */
|
||||
if (ticks > UINT64_MAX - offset_ticks) {
|
||||
return 0;
|
||||
}
|
||||
ticks += offset_ticks;
|
||||
} else {
|
||||
/* 先检查再减,防止越过计数原点后回绕为很大的时间值。 */
|
||||
if (ticks < offset_ticks) {
|
||||
return 0;
|
||||
}
|
||||
ticks -= offset_ticks;
|
||||
}
|
||||
/* 拆回 FILETIME,由系统重新计算全部日历字段,毫秒随计数一起保留。 */
|
||||
encoded.dwLowDateTime = (DWORD)(ticks & UINT64_C(0xFFFFFFFF));
|
||||
encoded.dwHighDateTime = (DWORD)(ticks >> 32);
|
||||
return FileTimeToSystemTime(&encoded, result) != 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:读取 Windows 系统时间,输出固定 UTC+8 标准时间。
|
||||
* 入口参数:value——接收结果的指针,不得为空。
|
||||
* 出口参数:value——合法日历及 is_invalid=0;失败时不修改调用方结果。
|
||||
* 返回值:1 取得合法结果;0 空指针、偏移转换失败或日历超出模块支持范围。
|
||||
* 说明:一次 GetSystemTime 取得完整 UTC 日历及毫秒,避免分次取字段时遇到秒或日期进位。
|
||||
* 固定加八小时,与 Windows 设置的本地时区无关;最终结果仍交由公共入口校验。
|
||||
*/
|
||||
static int Windows_Read(IEC60870_ClockValue_t *value)
|
||||
{
|
||||
IEC60870_ClockValue_t result = {0};
|
||||
SYSTEMTIME utc, local;
|
||||
|
||||
if (value == NULL) {
|
||||
return 0;
|
||||
}
|
||||
GetSystemTime(&utc);
|
||||
if (!Shift_Calendar(&utc, 1, &local)) {
|
||||
return 0;
|
||||
}
|
||||
result.time.year = local.wYear;
|
||||
result.time.month = (uint8_t)local.wMonth;
|
||||
result.time.day = (uint8_t)local.wDay;
|
||||
result.time.hour = (uint8_t)local.wHour;
|
||||
result.time.minute = (uint8_t)local.wMinute;
|
||||
result.time.second = (uint8_t)local.wSecond;
|
||||
result.time.ms = local.wMilliseconds;
|
||||
result.time.weekday = (uint8_t)local.wDayOfWeek;
|
||||
/* 加八小时可能跨到下一年,必须检查转换后的日历是否仍在 1970..2099 内。 */
|
||||
if (!IEC60870_Time_Is_Valid(&result.time)) {
|
||||
return 0;
|
||||
}
|
||||
/* Windows 读时接口不提供同步质量;0 仅表示未标记无效,不代表已校准或已同步。 */
|
||||
result.is_invalid = 0U;
|
||||
*value = result;
|
||||
return 1;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将固定 UTC+8 标准时间转换为 UTC,并实际修改 Windows 系统时钟。
|
||||
* 入口参数:local_time——1970..2099 的合法 UTC+8 日历,原始输入不会被修改。
|
||||
* 返回值:1 SetSystemTime 报告成功;0 参数非法、转换失败或系统调用失败。
|
||||
* 说明:SetSystemTime 接收 UTC,因此必须先减八小时;它不使用 wDayOfWeek 字段。
|
||||
* 调用进程需要系统设时权限,权限不足时返回 0;成功与否以系统调用结果为准。
|
||||
*/
|
||||
static int Windows_Set(const IEC60870_WallTime_t *local_time)
|
||||
{
|
||||
SYSTEMTIME local = {0}, utc;
|
||||
|
||||
if (!IEC60870_Time_Is_Valid(local_time)) {
|
||||
return 0;
|
||||
}
|
||||
local.wYear = local_time->year;
|
||||
local.wMonth = local_time->month;
|
||||
local.wDay = local_time->day;
|
||||
local.wHour = local_time->hour;
|
||||
local.wMinute = local_time->minute;
|
||||
local.wSecond = local_time->second;
|
||||
local.wMilliseconds = local_time->ms;
|
||||
if (!Shift_Calendar(&local, 0, &utc)) {
|
||||
return 0;
|
||||
}
|
||||
return SetSystemTime(&utc) != 0;
|
||||
}
|
||||
|
||||
#endif /* _WIN32 */
|
||||
#endif /* !IEC60870_CLOCK_USE_RTC */
|
||||
|
||||
/*
|
||||
* 函数功能:检查完整日历,再根据年月日重算星期,保证日期与星期一致。
|
||||
* 入口参数:time——公共读写入口持有的局部日历副本。
|
||||
* 出口参数:time->weekday——0=周日,1=周一,...,6=周六;其他字段保持原值。
|
||||
* 返回值:1 日历合法且星期计算成功;0 空指针、日历非法或星期计算失败。
|
||||
* 说明:传入的 weekday 不参与合法性判断;本函数不校准时钟,也不转换时区。
|
||||
*/
|
||||
static int Normalize_Calendar(IEC60870_WallTime_t *time)
|
||||
{
|
||||
if (!IEC60870_Time_Is_Valid(time)) {
|
||||
return 0;
|
||||
}
|
||||
return IEC60870_Time_Get_Weekday(time->year, time->month, time->day, &time->weekday);
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:从选定的 Windows 或 RTC 时间源读取日历,检查完成后再提交输出。
|
||||
* 入口参数:value——接收结果的指针,不得为空。
|
||||
* 出口参数:value——固定 UTC+8 日历、重算的星期及时间源提供的 is_invalid。
|
||||
* 返回值:1 得到合法日历和 0/1 质量标志;0 参数非法、底层读取失败或结果非法。
|
||||
* 说明:返回 1 只表示本次读取完成,is_invalid=1 的结果仍需业务按无效时间处理。
|
||||
* 底层仅操作局部结果,失败前即使写入了部分字段,也不会修改调用方输出。
|
||||
*/
|
||||
int IEC60870_Clock_Read(IEC60870_ClockValue_t *value)
|
||||
{
|
||||
IEC60870_ClockValue_t result = {0};
|
||||
int status;
|
||||
|
||||
if (value == NULL) {
|
||||
return 0;
|
||||
}
|
||||
/* 驱动未主动报告有效状态时,保留无效标志,不因零初始化而假定时钟有效。 */
|
||||
result.is_invalid = 1U;
|
||||
#if IEC60870_CLOCK_USE_RTC
|
||||
/* RTC 直接提供 UTC+8 日历,公共层无需将其转成时间戳再还原。 */
|
||||
status = IEC60870_Clock_RTC_Read(&result);
|
||||
#else
|
||||
status = Windows_Read(&result);
|
||||
#endif
|
||||
/* 底层必须明确返回 1;质量值只能为 0/1,日历通过检查后才覆盖输出。 */
|
||||
if (status != 1 || result.is_invalid > 1U || !Normalize_Calendar(&result.time)) {
|
||||
return 0;
|
||||
}
|
||||
*value = result;
|
||||
return 1;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:检查固定 UTC+8 日历,将重算星期的副本交给选定的时间源设置。
|
||||
* 入口参数:local_time——待设置的完整日历,不得为空;传入的 weekday 会被重新计算。
|
||||
* 返回值:1 底层明确报告设置成功;0 参数非法或底层未报告成功。
|
||||
* 说明:先复制并校验,检查失败时不调用底层,也不修改原始输入。
|
||||
* 校时报文的 IV/SU、源时区及业务校时条件应由上层处理,本入口只接收日历。
|
||||
* 返回 0 不保证硬件未发生部分写入,公共层不提供设备写入回滚。
|
||||
*/
|
||||
int IEC60870_Clock_Set(const IEC60870_WallTime_t *local_time)
|
||||
{
|
||||
IEC60870_WallTime_t prepared;
|
||||
|
||||
if (local_time == NULL) {
|
||||
return 0;
|
||||
}
|
||||
prepared = *local_time;
|
||||
if (!Normalize_Calendar(&prepared)) {
|
||||
return 0;
|
||||
}
|
||||
#if IEC60870_CLOCK_USE_RTC
|
||||
return IEC60870_Clock_RTC_Set(&prepared) == 1;
|
||||
#else
|
||||
return Windows_Set(&prepared) == 1;
|
||||
#endif
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
/*
|
||||
* IEC 60870-5-101/104 共用时间源接口:读取当前日历、设置实际时钟。
|
||||
* 读写日历统一采用固定UTC+8标准时间,年份1970..2099;CP56编码另限2000..2099。
|
||||
* 此处的本地时间指固定UTC+8,不随Windows本地时区设置或夏令时变化。
|
||||
* 时间源仅考虑Windows系统时钟和RTC,构建时二选一,业务直接调用Clock_Read/Clock_Set。
|
||||
* Windows实现已提供;RTC目前只保留接入接口,具体芯片驱动暂不实现。
|
||||
* 与IEC60870_Time的日期转换、CP56编解码分工;不自动接入ASDU或链路单调计时。
|
||||
*/
|
||||
#ifndef IEC60870_CLOCK_H
|
||||
#define IEC60870_CLOCK_H
|
||||
|
||||
#include "IEC60870_Time.h"
|
||||
|
||||
/*
|
||||
* 时间源编译选项:0=Windows系统时钟(默认,须在Windows构建),1=RTC预留接口。
|
||||
* 这是编译时选择,不在运行期间切换;RTC模式不编译Windows读写代码。
|
||||
* 选项须作用于IEC60870_Clock.c的编译,不能只在业务源文件中定义。
|
||||
* RTC模式须由板级驱动实现下方的Clock_RTC_Read/Set;本模块不提供芯片驱动。
|
||||
* 此选项与IEC60870_TIME_USE_PLATFORM的日期转换算法选择相互独立:
|
||||
* 前者决定从哪里读取/设置当前时间,后者决定如何将UTC秒数转换为日历。
|
||||
* RTC已提供约定的日历时,Clock读写入口不需要时间戳与日历之间的往返转换。
|
||||
*/
|
||||
#ifndef IEC60870_CLOCK_USE_RTC
|
||||
#define IEC60870_CLOCK_USE_RTC 0
|
||||
#endif
|
||||
|
||||
#if IEC60870_CLOCK_USE_RTC != 0 && IEC60870_CLOCK_USE_RTC != 1
|
||||
#error "IEC60870_CLOCK_USE_RTC must be 0 (Windows) or 1 (RTC)"
|
||||
#endif
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/*
|
||||
* 时间源的读取结果。日历数值合法与时间质量分开表示。
|
||||
* is_invalid=1仍须提供合法日历;没有可用日历时,平台读时函数应返回0。
|
||||
* is_invalid=0仅表示未标记无效,不证明时钟已经校准或与外部时间源同步。
|
||||
*/
|
||||
typedef struct {
|
||||
IEC60870_WallTime_t time; /* 固定UTC+8标准时间,ms为0..999,星期由公共入口重算 */
|
||||
uint8_t is_invalid; /* 0=未标记无效,1=时间无效;可按业务约定传递给CP56的IV */
|
||||
} IEC60870_ClockValue_t;
|
||||
|
||||
/*
|
||||
* 构建:IEC60870_Clock.c + IEC60870_Time.c;Windows读写实现在Clock.c内部。
|
||||
* 以后接RTC时,定义IEC60870_CLOCK_USE_RTC=1并加入实现下方RTC接口的板级驱动。
|
||||
* 时间源由构建选择,公共接口不需要时钟对象、函数指针绑定或初始化。
|
||||
* RTC等硬件仍须由应用按驱动要求初始化;同一时钟的读写由调用方串行执行。
|
||||
* 本模块不提供设备锁,不进行动态内存分配。
|
||||
*/
|
||||
|
||||
/**
|
||||
* 功能:从构建时选定的时间源读取固定UTC+8标准时间,并校验日历和质量标志。
|
||||
* 输入:value——接收结果的指针,不得为空。
|
||||
* 输出:value——合法日历、星期(0=周日..6=周六)及源提供的is_invalid。
|
||||
* 返回:1 取得格式合法的结果,is_invalid可能为1;0 参数非法、底层失败或结果非法。
|
||||
* 说明:先读取局部变量,检查完成后才提交输出,失败不修改value。
|
||||
* 局部结果的is_invalid初始为1,驱动应按实际状态明确填写0或1。
|
||||
* 调用方须同时检查返回值和is_invalid,读取成功不等于时钟准确或已同步。
|
||||
*/
|
||||
int IEC60870_Clock_Read(IEC60870_ClockValue_t *value);
|
||||
|
||||
/**
|
||||
* 功能:将固定UTC+8标准时间交给构建时选定的时间源设置实际时钟。
|
||||
* 输入:local_time——非空,1970..2099的合法UTC+8标准时间;输入的weekday可忽略。
|
||||
* 返回:1 底层报告设置成功;0 参数非法、平台不支持设时或底层未报告成功。
|
||||
* 说明:先检查日历并重算星期,再将副本交给时间源实现,原始输入保持不变。
|
||||
* Windows分支转换为UTC后调用系统设时接口;RTC分支直接将日历交给驱动。
|
||||
* 本接口不接收IV/SU;校时报文须先通过CP56转换及业务校时条件检查。
|
||||
* 不提供硬件写入回滚;失败时设备是否已有部分修改由具体驱动决定。
|
||||
*/
|
||||
int IEC60870_Clock_Set(const IEC60870_WallTime_t *local_time);
|
||||
|
||||
/*
|
||||
* RTC预留接入接口:仅RTC模式需要由板级驱动实现,Windows模式不引用这两个符号。
|
||||
* 业务调用上方公共入口,下面的函数由公共层同步调用,无需注册回调或绑定时钟对象。
|
||||
* 不得保留输入/输出指针供返回后使用,也不能反向调用公共读写入口。
|
||||
* 本模块仅声明,不提供空实现或默认成功结果;RTC硬件由应用按驱动要求初始化。
|
||||
*/
|
||||
|
||||
/**
|
||||
* 功能:由板级驱动读取RTC日历,供IEC60870_Clock_Read调用。
|
||||
* 输入:value——公共层提供的非空局部结果,其is_invalid初始为1。
|
||||
* 输出:value——一组一致的固定UTC+8日历和is_invalid=0/1;weekday由公共层重算。
|
||||
* 返回:1 取得可供检查的日历;0 读取失败或没有可用日历。
|
||||
* 说明:驱动负责寄存器格式转换及读取一致性,避免读到跨秒、跨日拼接的字段。
|
||||
* RTC日历的时间基准由设备约定,驱动须保证输出为UTC+8;无毫秒能力时可填写ms=0。
|
||||
* 即使日历数值合法,停振、掉电等状态仍可能使时间无效,须按实际状态填写质量。
|
||||
*/
|
||||
int IEC60870_Clock_RTC_Read(IEC60870_ClockValue_t *value);
|
||||
|
||||
/**
|
||||
* 功能:由板级驱动设置RTC实际时钟,供IEC60870_Clock_Set调用。
|
||||
* 输入:local_time——非空,公共层已校验并重算星期的UTC+8日历副本,只在调用期间有效。
|
||||
* 返回:1 驱动报告设置成功;0 设置失败或设备不支持设置。
|
||||
* 说明:驱动负责将日历转换为芯片要求的寄存器格式,按芯片能力处理毫秒。
|
||||
* 只读驱动直接返回0;写入失败时可能已有部分寄存器改变,公共层不提供回滚。
|
||||
*/
|
||||
int IEC60870_Clock_RTC_Set(const IEC60870_WallTime_t *local_time);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* IEC60870_CLOCK_H */
|
||||
@@ -0,0 +1,190 @@
|
||||
/*
|
||||
* 101/104共用的无状态ASDU基础解析:参数校验、公共头及最低载荷长度检查。
|
||||
* 只处理调用方提供的字节和参数,不依赖APCI、TCP、串口或连接状态。
|
||||
* 具体信息对象的完整校验由IEC60870_Asdu和InformationObjects完成。
|
||||
*/
|
||||
#include "IEC60870_Codec.h"
|
||||
|
||||
#include <stddef.h>
|
||||
#include <string.h>
|
||||
|
||||
/* ASDU公共头中各组合字段的位掩码。 */
|
||||
#define IEC60870_ASDU_OBJECT_COUNT_MASK 0x7FU
|
||||
#define IEC60870_ASDU_SEQUENCE_MASK 0x80U
|
||||
#define IEC60870_ASDU_CAUSE_MASK 0x3FU
|
||||
#define IEC60870_ASDU_NEGATIVE_MASK 0x40U
|
||||
#define IEC60870_ASDU_TEST_MASK 0x80U
|
||||
#define IEC60870_ASDU_IOA_LEN 3U
|
||||
|
||||
/* 已知固定长度类型的单个信息对象总长,包含3字节IOA;0表示未在本表检查。
|
||||
* 保留IOA使读命令C_RD_NA_1的零数据长度与未知类型可区分。
|
||||
* Type ID是线上的协议值;变长文件段F_SG_NA_1及其他未列类型由业务解析。 */
|
||||
static const uint8_t asdu_object_lengths[] = {
|
||||
[1] = IEC60870_ASDU_IOA_LEN + 1U, /* M_SP_NA_1 */
|
||||
[2] = IEC60870_ASDU_IOA_LEN + 4U, /* M_SP_TA_1 */
|
||||
[3] = IEC60870_ASDU_IOA_LEN + 1U, /* M_DP_NA_1 */
|
||||
[4] = IEC60870_ASDU_IOA_LEN + 4U, /* M_DP_TA_1 */
|
||||
[5] = IEC60870_ASDU_IOA_LEN + 2U, /* M_ST_NA_1 */
|
||||
[6] = IEC60870_ASDU_IOA_LEN + 5U, /* M_ST_TA_1 */
|
||||
[7] = IEC60870_ASDU_IOA_LEN + 5U, /* M_BO_NA_1 */
|
||||
[8] = IEC60870_ASDU_IOA_LEN + 8U, /* M_BO_TA_1 */
|
||||
[9] = IEC60870_ASDU_IOA_LEN + 3U, /* M_ME_NA_1 */
|
||||
[10] = IEC60870_ASDU_IOA_LEN + 6U, /* M_ME_TA_1 */
|
||||
[11] = IEC60870_ASDU_IOA_LEN + 3U, /* M_ME_NB_1 */
|
||||
[12] = IEC60870_ASDU_IOA_LEN + 6U, /* M_ME_TB_1 */
|
||||
[13] = IEC60870_ASDU_IOA_LEN + 5U, /* M_ME_NC_1 */
|
||||
[14] = IEC60870_ASDU_IOA_LEN + 8U, /* M_ME_TC_1 */
|
||||
[15] = IEC60870_ASDU_IOA_LEN + 5U, /* M_IT_NA_1 */
|
||||
[16] = IEC60870_ASDU_IOA_LEN + 8U, /* M_IT_TA_1 */
|
||||
[17] = IEC60870_ASDU_IOA_LEN + 6U, /* M_EP_TA_1 */
|
||||
[18] = IEC60870_ASDU_IOA_LEN + 7U, /* M_EP_TB_1 */
|
||||
[19] = IEC60870_ASDU_IOA_LEN + 7U, /* M_EP_TC_1 */
|
||||
[20] = IEC60870_ASDU_IOA_LEN + 5U, /* M_PS_NA_1 */
|
||||
[21] = IEC60870_ASDU_IOA_LEN + 2U, /* M_ME_ND_1 */
|
||||
[30] = IEC60870_ASDU_IOA_LEN + 8U, /* M_SP_TB_1 */
|
||||
[31] = IEC60870_ASDU_IOA_LEN + 8U, /* M_DP_TB_1 */
|
||||
[32] = IEC60870_ASDU_IOA_LEN + 9U, /* M_ST_TB_1 */
|
||||
[33] = IEC60870_ASDU_IOA_LEN + 12U, /* M_BO_TB_1 */
|
||||
[34] = IEC60870_ASDU_IOA_LEN + 10U, /* M_ME_TD_1 */
|
||||
[35] = IEC60870_ASDU_IOA_LEN + 10U, /* M_ME_TE_1 */
|
||||
[36] = IEC60870_ASDU_IOA_LEN + 12U, /* M_ME_TF_1 */
|
||||
[37] = IEC60870_ASDU_IOA_LEN + 12U, /* M_IT_TB_1 */
|
||||
[38] = IEC60870_ASDU_IOA_LEN + 10U, /* M_EP_TD_1 */
|
||||
[39] = IEC60870_ASDU_IOA_LEN + 11U, /* M_EP_TE_1 */
|
||||
[40] = IEC60870_ASDU_IOA_LEN + 11U, /* M_EP_TF_1 */
|
||||
[41] = IEC60870_ASDU_IOA_LEN + 14U, /* S_IT_TC_1 */
|
||||
[45] = IEC60870_ASDU_IOA_LEN + 1U, /* C_SC_NA_1 */
|
||||
[46] = IEC60870_ASDU_IOA_LEN + 1U, /* C_DC_NA_1 */
|
||||
[47] = IEC60870_ASDU_IOA_LEN + 1U, /* C_RC_NA_1 */
|
||||
[48] = IEC60870_ASDU_IOA_LEN + 3U, /* C_SE_NA_1 */
|
||||
[49] = IEC60870_ASDU_IOA_LEN + 3U, /* C_SE_NB_1 */
|
||||
[50] = IEC60870_ASDU_IOA_LEN + 5U, /* C_SE_NC_1 */
|
||||
[51] = IEC60870_ASDU_IOA_LEN + 4U, /* C_BO_NA_1 */
|
||||
[58] = IEC60870_ASDU_IOA_LEN + 8U, /* C_SC_TA_1 */
|
||||
[59] = IEC60870_ASDU_IOA_LEN + 8U, /* C_DC_TA_1 */
|
||||
[60] = IEC60870_ASDU_IOA_LEN + 8U, /* C_RC_TA_1 */
|
||||
[61] = IEC60870_ASDU_IOA_LEN + 10U, /* C_SE_TA_1 */
|
||||
[62] = IEC60870_ASDU_IOA_LEN + 10U, /* C_SE_TB_1 */
|
||||
[63] = IEC60870_ASDU_IOA_LEN + 12U, /* C_SE_TC_1 */
|
||||
[64] = IEC60870_ASDU_IOA_LEN + 11U, /* C_BO_TA_1 */
|
||||
[70] = IEC60870_ASDU_IOA_LEN + 1U, /* M_EI_NA_1 */
|
||||
[100] = IEC60870_ASDU_IOA_LEN + 1U, /* C_IC_NA_1 */
|
||||
[101] = IEC60870_ASDU_IOA_LEN + 1U, /* C_CI_NA_1 */
|
||||
[102] = IEC60870_ASDU_IOA_LEN, /* C_RD_NA_1 */
|
||||
[103] = IEC60870_ASDU_IOA_LEN + 7U, /* C_CS_NA_1 */
|
||||
[104] = IEC60870_ASDU_IOA_LEN + 2U, /* C_TS_NA_1 */
|
||||
[105] = IEC60870_ASDU_IOA_LEN + 1U, /* C_RP_NA_1 */
|
||||
[106] = IEC60870_ASDU_IOA_LEN + 2U, /* C_CD_NA_1 */
|
||||
[107] = IEC60870_ASDU_IOA_LEN + 9U, /* C_TS_TA_1 */
|
||||
[110] = IEC60870_ASDU_IOA_LEN + 3U, /* P_ME_NA_1 */
|
||||
[111] = IEC60870_ASDU_IOA_LEN + 3U, /* P_ME_NB_1 */
|
||||
[112] = IEC60870_ASDU_IOA_LEN + 5U, /* P_ME_NC_1 */
|
||||
[113] = IEC60870_ASDU_IOA_LEN + 1U, /* P_AC_NA_1 */
|
||||
[120] = IEC60870_ASDU_IOA_LEN + 6U, /* F_FR_NA_1 */
|
||||
[121] = IEC60870_ASDU_IOA_LEN + 7U, /* F_SR_NA_1 */
|
||||
[122] = IEC60870_ASDU_IOA_LEN + 4U, /* F_SC_NA_1 */
|
||||
[123] = IEC60870_ASDU_IOA_LEN + 5U, /* F_LS_NA_1 */
|
||||
[124] = IEC60870_ASDU_IOA_LEN + 4U, /* F_AF_NA_1 */
|
||||
[126] = IEC60870_ASDU_IOA_LEN + 13U, /* F_DR_TA_1 */
|
||||
[127] = IEC60870_ASDU_IOA_LEN + 16U /* F_SC_NB_1 */
|
||||
};
|
||||
|
||||
/* 调用前已检查参数、可变公共头及ASDU总长。表中仍以3字节IOA为基准,
|
||||
* 计算时先减去基准IOA再加上配置宽度。仅检查已知固定长度对象是否被截短;
|
||||
* 不要求长度恰好相等,不解释对象内容,也不在这里判定零对象或SQ的业务合法性。 */
|
||||
static int ASDU_Payload_Length_Valid(const IEC60870_AppLayerParameters_t *parameters,
|
||||
const uint8_t *asdu, uint16_t asdu_len, uint16_t header_length)
|
||||
{
|
||||
uint32_t object_count = asdu[1] & IEC60870_ASDU_OBJECT_COUNT_MASK;
|
||||
uint32_t object_length;
|
||||
uint32_t required_length;
|
||||
|
||||
if (object_count == 0U || asdu[0] >= sizeof(asdu_object_lengths)) {
|
||||
return 1;
|
||||
}
|
||||
object_length = asdu_object_lengths[asdu[0]];
|
||||
if (object_length == 0U) {
|
||||
return 1;
|
||||
}
|
||||
if ((asdu[1] & IEC60870_ASDU_SEQUENCE_MASK) != 0U) {
|
||||
/* 连续地址只传首个IOA;非连续地址则每个对象均携带IOA。 */
|
||||
required_length = (uint32_t)parameters->sizeOfIOA +
|
||||
object_count * (object_length - IEC60870_ASDU_IOA_LEN);
|
||||
} else {
|
||||
required_length = object_count *
|
||||
(object_length - IEC60870_ASDU_IOA_LEN + (uint32_t)parameters->sizeOfIOA);
|
||||
}
|
||||
return (uint32_t)(asdu_len - header_length) >= required_length;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:检查101/104共用应用层参数的字段宽度、源发地址和总长上限。
|
||||
* 输入参数:parameters——待检查参数,允许NULL。
|
||||
* 输出参数:无。
|
||||
* 返回值:合法返回1,NULL或非法字段返回0。
|
||||
* 说明:先校验小范围字段再计算头长,不选择默认配置或修改参数。
|
||||
*/
|
||||
int IEC60870_AppLayerParameters_Valid(const IEC60870_AppLayerParameters_t *parameters)
|
||||
{
|
||||
return parameters != NULL && parameters->sizeOfTypeId == 1 &&
|
||||
parameters->sizeOfVSQ == 1 &&
|
||||
(parameters->sizeOfCOT == 1 || parameters->sizeOfCOT == 2) &&
|
||||
(parameters->sizeOfCA == 1 || parameters->sizeOfCA == 2) &&
|
||||
parameters->sizeOfIOA >= 1 && parameters->sizeOfIOA <= 3 &&
|
||||
parameters->originatorAddress >= 0 && parameters->originatorAddress <= 255 &&
|
||||
parameters->maxSizeOfASDU >= 2 + parameters->sizeOfCOT + parameters->sizeOfCA &&
|
||||
parameters->maxSizeOfASDU <= IEC60870_MAX_ASDU_LEN;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:检查ASDU公共头及已知固定长度对象的最低载荷长度,解析公共头。
|
||||
* 输入参数:parameters——双方约定的非空应用层参数;asdu/asdu_len——完整ASDU。
|
||||
* 输出参数:asdu_info——解析成功时写入公共头字段和信息对象区位置。
|
||||
* 返回值:解析成功返回1,参数或长度非法返回0且不修改asdu_info。
|
||||
* 说明:按Type ID、VSQ数量及SQ位检查最低载荷长度;未知/变长类型及零对象不做此检查。
|
||||
* 不检查多余尾字节、SQ/数量的类型约束、传送原因、地址或信息对象内容是否合法。
|
||||
*/
|
||||
int IEC60870_Parse_ASDU_Header(const IEC60870_AppLayerParameters_t *parameters,
|
||||
const uint8_t *asdu,
|
||||
uint16_t asdu_len,
|
||||
IEC60870_AsduInfo_t *asdu_info)
|
||||
{
|
||||
IEC60870_AsduInfo_t result;
|
||||
uint16_t header_length;
|
||||
unsigned int ca_index;
|
||||
|
||||
if (asdu == NULL || asdu_info == NULL || !IEC60870_AppLayerParameters_Valid(parameters)) {
|
||||
return 0;
|
||||
}
|
||||
header_length = (uint16_t)(2 + parameters->sizeOfCOT + parameters->sizeOfCA);
|
||||
if (asdu_len < header_length || asdu_len > parameters->maxSizeOfASDU ||
|
||||
!ASDU_Payload_Length_Valid(parameters, asdu, asdu_len, header_length)) {
|
||||
return 0;
|
||||
}
|
||||
/* COT为1字节时CA紧跟COT,不存在OA;先组装局部结果,再一次性发布。 */
|
||||
memset(&result, 0, sizeof(result));
|
||||
ca_index = (unsigned int)(2 + parameters->sizeOfCOT);
|
||||
result.common_address = asdu[ca_index];
|
||||
if (parameters->sizeOfCA == 2) {
|
||||
result.common_address |= (uint16_t)((uint16_t)asdu[ca_index + 1U] << 8);
|
||||
}
|
||||
result.type_id = asdu[0];
|
||||
result.object_count =
|
||||
(uint8_t)(asdu[1] & IEC60870_ASDU_OBJECT_COUNT_MASK);
|
||||
result.is_sequence =
|
||||
(uint8_t)((asdu[1] & IEC60870_ASDU_SEQUENCE_MASK) != 0U);
|
||||
result.cause_of_transmission =
|
||||
(uint8_t)(asdu[2] & IEC60870_ASDU_CAUSE_MASK);
|
||||
result.is_negative_confirm =
|
||||
(uint8_t)((asdu[2] & IEC60870_ASDU_NEGATIVE_MASK) != 0U);
|
||||
result.is_test =
|
||||
(uint8_t)((asdu[2] & IEC60870_ASDU_TEST_MASK) != 0U);
|
||||
result.originator_address = parameters->sizeOfCOT == 2 ? asdu[3] : 0;
|
||||
result.information_objects = &asdu[header_length];
|
||||
result.information_objects_len = (uint16_t)(asdu_len - header_length);
|
||||
result.parameters = parameters;
|
||||
*asdu_info = result;
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
/* 101/104共用的ASDU公共头解析与参数检查,不包含传输帧接口。 */
|
||||
#ifndef IEC60870_CODEC_H
|
||||
#define IEC60870_CODEC_H
|
||||
|
||||
#include "IEC60870_Types.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* ASDU公共头的解析结果;本模块不解析具体信息对象,调用方按type_id另行处理。 */
|
||||
typedef struct {
|
||||
uint8_t type_id; /* 类型标识 */
|
||||
uint8_t object_count; /* VSQ中的信息对象数量 */
|
||||
uint8_t is_sequence; /* VSQ中的SQ标志 */
|
||||
uint8_t cause_of_transmission; /* 传送原因,不含标志位 */
|
||||
uint8_t is_negative_confirm; /* 传送原因中的P/N标志 */
|
||||
uint8_t is_test; /* 传送原因中的TEST标志 */
|
||||
uint8_t originator_address; /* 源发地址 */
|
||||
uint16_t common_address; /* ASDU公共地址 */
|
||||
const uint8_t *information_objects; /* 信息对象区首地址 */
|
||||
uint16_t information_objects_len; /* 信息对象区长度 */
|
||||
const IEC60870_AppLayerParameters_t *parameters; /* 借用本次解析参数,不可修改。 */
|
||||
} IEC60870_AsduInfo_t;
|
||||
|
||||
/**
|
||||
* 功能:校验应用层字段宽度、默认源发地址及ASDU总长上限。
|
||||
* 输入参数:parameters——待检查参数,允许NULL。
|
||||
* 输出参数:无。
|
||||
* 返回值:合法返回1,NULL或非法值返回0。
|
||||
* 说明:不修改参数,不替调用方选择101/104的传输配置。
|
||||
*/
|
||||
extern int IEC60870_AppLayerParameters_Valid(const IEC60870_AppLayerParameters_t *parameters);
|
||||
|
||||
/**
|
||||
* 功能:检查ASDU公共头及已知固定长度对象的最低载荷长度,解析公共头。
|
||||
* 输入参数:parameters——非空应用层参数;asdu——ASDU首地址;asdu_len——总长度。
|
||||
* 输出参数:asdu_info——解析成功时写入公共头字段和信息对象区位置。
|
||||
* 返回值:解析成功返回1,参数或长度非法返回0且不修改asdu_info。
|
||||
* 说明:头长为2+sizeOfCOT+sizeOfCA,IOA及最低载荷长度按sizeOfIOA计算。
|
||||
* 未知/变长类型及零对象不做载荷检查;不检查多余尾字节、SQ/数量的类型约束、
|
||||
* 传送原因、地址或信息对象内容是否合法。接收器在链路受理前调用本函数。
|
||||
* information_objects及parameters均为借用,取对象期间报文和参数必须有效且不变。
|
||||
*/
|
||||
extern int IEC60870_Parse_ASDU_Header(const IEC60870_AppLayerParameters_t *parameters,
|
||||
const uint8_t *asdu,
|
||||
uint16_t asdu_len,
|
||||
IEC60870_AsduInfo_t *asdu_info);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* IEC60870_CODEC_H */
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,83 @@
|
||||
/* 信息对象与ASDU的内部协作,不作为业务API。
|
||||
* ASDU使用类型描述计算布局;具体对象通过只读函数表编码;解码按Type ID另行分派。
|
||||
* 字节辅助函数不读写连接状态,也不依赖结构体对齐或主机字节序。 */
|
||||
#ifndef IEC60870_INFORMATION_OBJECTS_INTERNAL_H
|
||||
#define IEC60870_INFORMATION_OBJECTS_INTERNAL_H
|
||||
|
||||
#include "IEC60870_InformationObjects.h"
|
||||
|
||||
/* 单个文件段LOS最多255字节,另有4字节文件段头和最多3字节IOA。
|
||||
* 即使对象可表示更长载荷,ASDU容器仍按配置的总长上限返回FULL。 */
|
||||
#define IEC60870_OBJECT_MAX_PAYLOAD 259U
|
||||
#define IEC60870_OBJECT_MAX_ENCODED (IEC60870_OBJECT_MAX_PAYLOAD + 3U)
|
||||
|
||||
/* 每个类型独立的只读编码函数表;解码仍由Type ID选择具体类型的解析函数。
|
||||
* encode仅写临时载荷,公共入口验证后原子提交;变长类型提供两个长度回调。 */
|
||||
typedef struct IEC60870_InformationObjectVTable {
|
||||
uint8_t type_id; /* 线上类型标识;同时用于核对对象基类身份。 */
|
||||
uint16_t payload_size; /* 固定类型的精确长度;变长类型的最低长度,不含IOA。 */
|
||||
uint8_t single_object; /* 1表示仅允许一个对象;SQ约束由supports_sequence独立决定。 */
|
||||
size_t object_size; /* 具体C结构的sizeof,用于输出存储检查,与线上长度无关。 */
|
||||
int (*encode)(const IEC60870_InformationObject_t *object, uint8_t *payload); /* 写临时载荷,1成功/0字段非法。 */
|
||||
uint8_t supports_sequence; /* 1允许SQ=1;参数类型允许多个对象但仅支持SQ=0。 */
|
||||
uint16_t (*get_payload_size)(const IEC60870_InformationObject_t *object); /* NULL为固定长度。 */
|
||||
uint16_t (*get_payload_size_from_buffer)(const uint8_t *payload, uint16_t length); /* 变长载荷精确长度;0非法。 */
|
||||
} IEC60870_InformationObjectVTable;
|
||||
|
||||
/* 未支持的Type ID返回NULL;地址和长度校验由使用方在读报文前完成。 */
|
||||
const IEC60870_InformationObjectVTable *IEC60870_InformationObject_Get_Descriptor(uint8_t type_id);
|
||||
|
||||
/* 按Type ID调用具体Get_From_Buffer;object==NULL时仅验证,不输出。
|
||||
* object_size是调用方实际提供的容量,必须至少为所选具体类型的sizeof;
|
||||
* 非空object必须对应该具体结构,尺寸足够不能替代类型匹配。失败不修改输出。 */
|
||||
IEC60870_AsduResult_t IEC60870_InformationObject_Decode(uint8_t type_id, uint32_t ioa,
|
||||
const uint8_t *payload, uint16_t length, void *object, size_t object_size);
|
||||
|
||||
/**
|
||||
* 功能:从低字节在前的字节序列读取无符号值。
|
||||
* 输入参数:data——至少length字节的有效输入,调用方先完成边界检查。
|
||||
* length——1..4,用于1/2/3字节地址或2/4字节数值。
|
||||
* 输出参数:无。
|
||||
* 返回值:按位拼接的uint32_t,未使用高位为0。
|
||||
* 说明:逐字节读,允许未对齐输入;不检查指针或范围。
|
||||
*/
|
||||
static inline uint32_t IEC60870_Object_Read_LE(const uint8_t *data, unsigned int length)
|
||||
{
|
||||
uint32_t value = 0;
|
||||
unsigned int i;
|
||||
for (i = 0; i < length; ++i) {
|
||||
value |= (uint32_t)data[i] << (8U * i);
|
||||
}
|
||||
return value;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:将数值低length字节按低字节在前写入报文。
|
||||
* 输入参数:value——待写数值;需要保留的高位是否越界由调用方预先检查。
|
||||
* length——1..4;只写指定字节数,不写尾部填充。
|
||||
* 输出参数:data——至少length字节的可写区域。
|
||||
* 返回值:无。
|
||||
* 说明:逐字节写,不要求对齐;IOA必须先按所选宽度校验,防止被静默截断。
|
||||
*/
|
||||
static inline void IEC60870_Object_Write_LE(uint8_t *data, uint32_t value, unsigned int length)
|
||||
{
|
||||
unsigned int i;
|
||||
for (i = 0; i < length; ++i) {
|
||||
data[i] = (uint8_t)(value >> (8U * i));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:计算所选IOA字段宽度能够表示的最大地址。
|
||||
* 输入参数:parameters——非空且已通过AppLayerParameters_Valid校验,sizeOfIOA为1..3。
|
||||
* 输出参数:无。
|
||||
* 返回值:分别为0xFF、0xFFFF或0xFFFFFF。
|
||||
* 说明:位移最多24位;本函数不检查参数,非法宽度不得传入。
|
||||
*/
|
||||
static inline uint32_t IEC60870_Object_Max_IOA(const IEC60870_AppLayerParameters_t *parameters)
|
||||
{
|
||||
return (UINT32_C(1) << (8U * (unsigned int)parameters->sizeOfIOA)) - 1U;
|
||||
}
|
||||
|
||||
#endif /* IEC60870_INFORMATION_OBJECTS_INTERNAL_H */
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
/* 共用发送入口只做接口分派;101/104分别提供其实际处理函数。 */
|
||||
#include "IEC60870_Slave.h"
|
||||
|
||||
/**
|
||||
* 功能:将普通ASDU发送请求分派给对应协议。
|
||||
* 输入参数:self——连接接口;asdu——待提交ASDU。
|
||||
* 输出参数:由接入实现记录提交结果。
|
||||
* 返回值:接入函数的布尔结果;连接或函数指针为空时返回false。
|
||||
* 说明:ASDU合法性由接入实现检查,便于同一次调用记录准确的失败原因。
|
||||
*/
|
||||
bool IEC60870_MasterConnection_Send_ASDU(IEC60870_MasterConnection_t *self, IEC60870_Asdu_t *asdu)
|
||||
{
|
||||
return self != NULL && self->send_asdu != NULL && self->send_asdu(self, asdu);
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:将激活确认请求分派给对应协议。
|
||||
* 输入参数:self——连接接口;asdu——可修改ASDU;negative——否定标志。
|
||||
* 输出参数:由接入实现修改ASDU并记录提交结果。
|
||||
* 返回值:接入函数的布尔结果;连接或函数指针为空时返回false。
|
||||
* 说明:共用入口不依赖TCP或串口,不保存请求或执行重试。
|
||||
*/
|
||||
bool IEC60870_MasterConnection_Send_ACT_CON(IEC60870_MasterConnection_t *self,
|
||||
IEC60870_Asdu_t *asdu, bool negative)
|
||||
{
|
||||
return self != NULL && self->send_act_con != NULL && self->send_act_con(self, asdu, negative);
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:将激活终止请求分派给对应协议。
|
||||
* 输入参数:self——连接接口;asdu——可修改ASDU。
|
||||
* 输出参数:由接入实现修改ASDU并记录提交结果。
|
||||
* 返回值:接入函数的布尔结果;连接或函数指针为空时返回false。
|
||||
* 说明:本入口不判断业务是否完成,调用时机由业务决定。
|
||||
*/
|
||||
bool IEC60870_MasterConnection_Send_ACT_TERM(IEC60870_MasterConnection_t *self, IEC60870_Asdu_t *asdu)
|
||||
{
|
||||
return self != NULL && self->send_act_term != NULL && self->send_act_term(self, asdu);
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:通过协议接入获取应用层参数。
|
||||
* 输入参数:self——连接接口。
|
||||
* 输出参数:无。
|
||||
* 返回值:接入提供的只读参数指针;连接或函数指针为空时返回NULL。
|
||||
* 说明:不创建默认参数,不改变连接状态,也不延长参数的生命周期。
|
||||
*/
|
||||
const IEC60870_AppLayerParameters_t *IEC60870_MasterConnection_Get_Application_Layer_Parameters(
|
||||
IEC60870_MasterConnection_t *self)
|
||||
{
|
||||
if (self == NULL || self->get_application_layer_parameters == NULL) { return NULL; }
|
||||
return self->get_application_layer_parameters(self);
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
/*
|
||||
* 101/104共用的子站发送接口,表示一条面向主站的连接。
|
||||
* 共用入口通过函数指针分派;具体发送、确认和终止由对应协议接入实现。
|
||||
* 本层不包含TCP、串口、队列或连接状态机,不分配内存。
|
||||
*/
|
||||
#ifndef IEC60870_SLAVE_H
|
||||
#define IEC60870_SLAVE_H
|
||||
|
||||
#include "IEC60870_Asdu.h"
|
||||
#include <stdbool.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
typedef struct IEC60870_MasterConnection IEC60870_MasterConnection_t;
|
||||
|
||||
/* 接入实现初始化此接口并保证object及函数指针有效;业务通过下面的函数调用。
|
||||
* 参数及ASDU的实际布局必须与所接协议一致。所有调用由所属事件循环串行执行。
|
||||
* send返回true前必须复制或消耗ASDU原文,不能在返回后继续借用调用方字节。
|
||||
* false不统一表示可重试,具体接入实现负责提供失败原因和处理约定。 */
|
||||
struct IEC60870_MasterConnection {
|
||||
void *object; /* 协议接入上下文;共用入口不解释此指针。 */
|
||||
bool (*send_asdu)(IEC60870_MasterConnection_t *self, IEC60870_Asdu_t *asdu);
|
||||
bool (*send_act_con)(IEC60870_MasterConnection_t *self, IEC60870_Asdu_t *asdu, bool negative);
|
||||
bool (*send_act_term)(IEC60870_MasterConnection_t *self, IEC60870_Asdu_t *asdu);
|
||||
const IEC60870_AppLayerParameters_t *(*get_application_layer_parameters)(
|
||||
IEC60870_MasterConnection_t *self);
|
||||
};
|
||||
|
||||
/**
|
||||
* 功能:通过当前连接提交一条已构造好的ASDU。
|
||||
* 输入参数:self——已由协议接入初始化的连接;asdu——有效ASDU对象。
|
||||
* 输出参数:具体接入实现记录本次提交结果;本入口不修改ASDU字段。
|
||||
* 返回值:true表示已发送或已被发送模块接手;false表示失败。
|
||||
* 说明:true不等于主站已确认;false后按具体协议的结果处理,不自动重试。
|
||||
*/
|
||||
bool IEC60870_MasterConnection_Send_ASDU(IEC60870_MasterConnection_t *self, IEC60870_Asdu_t *asdu);
|
||||
|
||||
/**
|
||||
* 功能:通过当前连接发送激活确认。
|
||||
* 输入参数:self——已初始化连接;asdu——可修改ASDU;negative——是否否定确认。
|
||||
* 输出参数:asdu原地设置COT=7及指定P/N;具体接入实现记录提交结果。
|
||||
* 返回值:true表示发送模块已接手;false表示失败。
|
||||
* 说明:字段在提交前修改,提交失败也不会恢复;不执行请求中的业务命令。
|
||||
*/
|
||||
bool IEC60870_MasterConnection_Send_ACT_CON(IEC60870_MasterConnection_t *self,
|
||||
IEC60870_Asdu_t *asdu, bool negative);
|
||||
|
||||
/**
|
||||
* 功能:通过当前连接发送激活终止。
|
||||
* 输入参数:self——已初始化连接;asdu——对应请求的可修改ASDU对象。
|
||||
* 输出参数:asdu原地设置COT=10、P/N=0;具体接入实现记录提交结果。
|
||||
* 返回值:true表示发送模块已接手;false表示失败。
|
||||
* 说明:业务在相应处理完成后调用;提交失败也不恢复已修改的字段。
|
||||
*/
|
||||
bool IEC60870_MasterConnection_Send_ACT_TERM(IEC60870_MasterConnection_t *self,
|
||||
IEC60870_Asdu_t *asdu);
|
||||
|
||||
/**
|
||||
* 功能:获取当前连接使用的应用层参数。
|
||||
* 输入参数:self——已初始化连接。
|
||||
* 输出参数:无。
|
||||
* 返回值:借用的只读参数指针;接口为空或未实现时返回NULL。
|
||||
* 说明:返回指针的有效期由协议接入定义;调用方不能修改参数。
|
||||
*/
|
||||
const IEC60870_AppLayerParameters_t *IEC60870_MasterConnection_Get_Application_Layer_Parameters(
|
||||
IEC60870_MasterConnection_t *self);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
#endif /* IEC60870_SLAVE_H */
|
||||
@@ -0,0 +1,502 @@
|
||||
/*
|
||||
* IEC 60870-5-101/104 公共时间工具:日历计算、CP56Time2a 编解码及本地标准时间转换。
|
||||
* 供 101 和 104 的业务层按需调用,编解码不读取协议类型或链路状态。
|
||||
* CP56 编解码保留 IV 和 SU;转本地标准时间时检查 IV,处理 SU 和源时区,返回完整日历。
|
||||
* 公共编码允许 SU=0/1;后续业务发送入口负责提供本地标准时间日历并设置 SU=0。
|
||||
* 本文件只提供公共工具,不自动接入 ASDU 业务处理或执行校时。
|
||||
* 整数公历换算按 400 年周期展开,将三月作为年内起点以统一处理二月和闰日。
|
||||
* 仅在校验后的 1970..2099 年范围内运算,天数及秒数均可用 uint32_t 表示。
|
||||
* 时间戳转日历可选平台库或纯整数算法;接入层提供约定的标准时区偏移,负责系统时钟、RTC 和单调计时。
|
||||
*/
|
||||
#include "IEC60870_Time.h"
|
||||
|
||||
#include <string.h>
|
||||
|
||||
/**
|
||||
* 功能:编码两字节经过时间。
|
||||
* 输入参数:value——毫秒值;capacity——out的实际容量。
|
||||
* 输出参数:out——成功写入2字节,失败不变。
|
||||
* 返回值:1成功;0空指针或容量不足。
|
||||
* 说明:先保存输入,允许输入输出重叠;不将经过时间解释为日历时间。
|
||||
*/
|
||||
int IEC60870_Time_To_CP16(const IEC60870_CP16Time2a_t *value, uint8_t *out, size_t capacity)
|
||||
{
|
||||
uint16_t milliseconds;
|
||||
if (value == NULL || out == NULL || capacity < IEC60870_CP16_LEN) { return 0; }
|
||||
milliseconds = value->milliseconds;
|
||||
out[0] = (uint8_t)milliseconds;
|
||||
out[1] = (uint8_t)(milliseconds >> 8);
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:解码两字节经过时间。
|
||||
* 输入参数:in——低字节在前的输入;length——至少2字节。
|
||||
* 输出参数:value——经过时间,失败不变。
|
||||
* 返回值:1成功;0空指针或长度不足。
|
||||
* 说明:CP16使用完整16位数值范围,不含质量标志。
|
||||
*/
|
||||
int IEC60870_Time_From_CP16(const uint8_t *in, size_t length, IEC60870_CP16Time2a_t *value)
|
||||
{
|
||||
IEC60870_CP16Time2a_t result;
|
||||
if (in == NULL || value == NULL || length < IEC60870_CP16_LEN) { return 0; }
|
||||
result.milliseconds = (uint16_t)((uint16_t)in[0] | ((uint16_t)in[1] << 8));
|
||||
*value = result;
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:编码三字节短时标。
|
||||
* 输入参数:value——分钟、分钟内毫秒和IV;capacity——out容量。
|
||||
* 输出参数:out——成功写入3字节,失败不变。
|
||||
* 返回值:1成功;0参数或字段非法。
|
||||
* 说明:分钟0..59,毫秒0..59999,IV为0/1;第三字节bit6始终为0。
|
||||
*/
|
||||
int IEC60870_Time_To_CP24(const IEC60870_CP24Time2a_t *value, uint8_t *out, size_t capacity)
|
||||
{
|
||||
uint8_t encoded[IEC60870_CP24_LEN];
|
||||
if (value == NULL || out == NULL || capacity < sizeof(encoded) ||
|
||||
value->milliseconds > 59999U || value->minute > 59U || value->is_invalid > 1U) { return 0; }
|
||||
encoded[0] = (uint8_t)value->milliseconds;
|
||||
encoded[1] = (uint8_t)(value->milliseconds >> 8);
|
||||
encoded[2] = (uint8_t)(value->minute | (value->is_invalid << 7));
|
||||
memcpy(out, encoded, sizeof(encoded));
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* 功能:校验并解码三字节短时标。
|
||||
* 输入参数:in——至少3字节;length——实际可读长度。
|
||||
* 输出参数:value——成功保存解析值;失败保持原值。
|
||||
* 返回值:1成功;0长度、保留位、分钟或毫秒非法。
|
||||
* 说明:IV保留;调用方结合已有时间基准恢复小时及日期。
|
||||
*/
|
||||
int IEC60870_Time_From_CP24(const uint8_t *in, size_t length, IEC60870_CP24Time2a_t *value)
|
||||
{
|
||||
IEC60870_CP24Time2a_t result = {0};
|
||||
if (in == NULL || value == NULL || length < IEC60870_CP24_LEN || (in[2] & 0x40U)) { return 0; }
|
||||
result.milliseconds = (uint16_t)((uint16_t)in[0] | ((uint16_t)in[1] << 8));
|
||||
result.minute = in[2] & 0x3FU;
|
||||
result.is_invalid = in[2] >> 7;
|
||||
if (result.milliseconds > 59999U || result.minute > 59U) { return 0; }
|
||||
*value = result;
|
||||
return 1;
|
||||
}
|
||||
|
||||
#if IEC60870_TIME_USE_PLATFORM != 0 && IEC60870_TIME_USE_PLATFORM != 1
|
||||
#error "IEC60870_TIME_USE_PLATFORM must be 0 or 1"
|
||||
#endif
|
||||
|
||||
#if IEC60870_TIME_USE_PLATFORM
|
||||
#ifndef _WIN32
|
||||
#error "Platform time conversion currently requires Windows; use IEC60870_TIME_USE_PLATFORM=0"
|
||||
#endif
|
||||
#include <time.h>
|
||||
#endif
|
||||
|
||||
/*
|
||||
* 函数功能:判断公历闰年。
|
||||
* 入口参数:year——公历年份;本函数只执行闰年规则,不检查模块支持的年份范围。
|
||||
* 返回值:1 为闰年,0 为平年。
|
||||
* 说明:能被 4 整除且不能被 100 整除,或能被 400 整除的年份为闰年。
|
||||
*/
|
||||
static int Is_Leap(uint32_t year)
|
||||
{
|
||||
return ((year % 4U) == 0U && (year % 100U) != 0U) || (year % 400U) == 0U;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:取得指定公历月份的实际天数。
|
||||
* 入口参数:year——公历年份;month——月份,合法范围为 1..12。
|
||||
* 返回值:合法月份返回 28..31,非法月份返回 0。
|
||||
* 说明:先检查月份再访问表,闰年二月单独返回 29;年份范围由上层日期检查负责。
|
||||
*/
|
||||
static uint32_t Days_In_Month(uint32_t year, uint32_t month)
|
||||
{
|
||||
static const uint8_t days[12] = {31U, 28U, 31U, 30U, 31U, 30U,
|
||||
31U, 31U, 30U, 31U, 30U, 31U};
|
||||
|
||||
if (month < 1U || month > 12U) {
|
||||
return 0U;
|
||||
}
|
||||
if (month == 2U && Is_Leap(year)) {
|
||||
return 29U;
|
||||
}
|
||||
return days[month - 1U];
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:统一检查年份范围和日期是否真实存在。
|
||||
* 入口参数:year——1970..2099;month——1..12;day——待检查的日号。
|
||||
* 返回值:1 为合法日期,0 为年份、月份或日号非法。
|
||||
* 说明:按当月实际天数检查 day,不接受平年二月二十九;非法月份的天数为 0,也会被拒绝。
|
||||
*/
|
||||
static int Date_Is_Valid(uint32_t year, uint32_t month, uint32_t day)
|
||||
{
|
||||
uint32_t limit;
|
||||
|
||||
if (year < IEC60870_TIME_MIN_YEAR || year > IEC60870_TIME_MAX_YEAR) {
|
||||
return 0;
|
||||
}
|
||||
limit = Days_In_Month(year, month);
|
||||
return day >= 1U && day <= limit;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:检查完整日历值的日期、时分秒和毫秒范围。
|
||||
* 入口参数:time——待检查的日历指针,可为空。
|
||||
* 返回值:1 为数值合法,0 为空指针、无效日期或时间字段越界。
|
||||
* 说明:小时 0..23,分/秒 0..59,毫秒 0..999;weekday 为派生字段,不参与检查。
|
||||
* 这里只检查数值,不能据此判断时间基准、时钟是否准确或该值是否允许用于校时。
|
||||
*/
|
||||
static int WallTime_Is_Valid(const IEC60870_WallTime_t *time)
|
||||
{
|
||||
return time != NULL && Date_Is_Valid(time->year, time->month, time->day) &&
|
||||
time->hour <= 23U && time->minute <= 59U && time->second <= 59U && time->ms <= 999U;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将公历日期转换为自 1970-01-01 起的完整天数。
|
||||
* 入口参数:year、month、day——已校验的合法日期,年份须在 1970..2099 内。
|
||||
* 返回值:完整天数,0 对应 1970-01-01;本内部函数不重复校验参数。
|
||||
* 说明:将三月作为年首,一、二月归入上一年,使闰日统一落在年末。
|
||||
* era 为 400 年周期编号,yoe 为周期内年份,mp 为从三月起算的月份编号 0..11。
|
||||
* doy 为从三月起算的年内天数,doe 为周期内天数;每 400 年有 146097 天。
|
||||
* 最后减去 719468,将算法的天数原点平移到 1970-01-01。
|
||||
*/
|
||||
static uint32_t Days_From_Civil(uint32_t year, uint32_t month, uint32_t day)
|
||||
{
|
||||
uint32_t y = (month <= 2U) ? (year - 1U) : year;
|
||||
uint32_t era = y / 400U;
|
||||
uint32_t yoe = y - era * 400U;
|
||||
uint32_t mp = (month > 2U) ? (month - 3U) : (month + 9U);
|
||||
uint32_t doy = (153U * mp + 2U) / 5U + day - 1U;
|
||||
uint32_t doe = yoe * 365U + yoe / 4U - yoe / 100U + doy;
|
||||
|
||||
return era * 146097U + doe - 719468U;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将已校验的日历字段展开为相对 1970-01-01 00:00:00 的线性秒数。
|
||||
* 入口参数:time——非空且已通过 WallTime_Is_Valid 检查的日历值。
|
||||
* 返回值:0..IEC60870_TIME_MAX_SECONDS 的完整秒数,不包含毫秒。
|
||||
* 说明:此处只计算天数和日内秒数,忽略 ms、weekday,不处理时区或 SU。
|
||||
* 只有输入日历本身采用 UTC 时,结果才可直接作为 UTC 纪元秒数使用。
|
||||
*/
|
||||
static uint32_t Seconds_From_Civil(const IEC60870_WallTime_t *time)
|
||||
{
|
||||
return Days_From_Civil(time->year, time->month, time->day) * 86400U +
|
||||
(uint32_t)time->hour * 3600U + (uint32_t)time->minute * 60U + (uint32_t)time->second;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:根据自 1970-01-01 起的完整天数计算星期。
|
||||
* 入口参数:days——模块支持年份内的天数,0 对应 1970-01-01。
|
||||
* 返回值:0=周日,1=周一,...,6=周六。
|
||||
* 说明:纪元日是周四,因此先加 4 再对 7 取余;本内部函数不检查日期范围。
|
||||
*/
|
||||
static uint8_t Weekday_From_Days(uint32_t days)
|
||||
{
|
||||
return (uint8_t)((days + 4U) % 7U);
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:供时间源适配等调用方复用日历合法性检查,不把本地日历当作UTC转秒数。
|
||||
* 入口参数:time——待检查的日历指针,可以为空;weekday不参与检查。
|
||||
* 返回值:1 年月日、时分秒和毫秒在模块范围内;0 参数非法。
|
||||
*/
|
||||
int IEC60870_Time_Is_Valid(const IEC60870_WallTime_t *time)
|
||||
{
|
||||
return WallTime_Is_Valid(time);
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:校验公历日期并计算星期。
|
||||
* 入口参数:year——1970..2099;month——1..12;day——当月日号。
|
||||
* 出口参数:weekday——接收 0..6 的星期值,0 表示周日。
|
||||
* 返回值:1 成功;0 日期非法或输出指针为空,失败时输出不变。
|
||||
*/
|
||||
int IEC60870_Time_Get_Weekday(uint16_t year, uint8_t month, uint8_t day, uint8_t *weekday)
|
||||
{
|
||||
if (weekday == NULL || !Date_Is_Valid(year, month, day)) {
|
||||
return 0;
|
||||
}
|
||||
*weekday = Weekday_From_Days(Days_From_Civil(year, month, day));
|
||||
return 1;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将 UTC 日历转换为自 1970-01-01 00:00:00 UTC 起的完整秒数。
|
||||
* 入口参数:time——1970..2099 年的合法 UTC 日历;ms 须在 0..999 内。
|
||||
* 出口参数:seconds——接收 0..IEC60870_TIME_MAX_SECONDS;0 是有效时间值。
|
||||
* 返回值:1 成功;0 参数非法,失败时输出不变。
|
||||
* 说明:日历类型没有时区或 SU,调用方须保证输入采用 UTC;ms 只检查范围,不计入完整秒数。
|
||||
* 含 IV/SU 的 CP56 解析值应使用 CP56_To_Seconds,不能直接丢弃标志后调用本函数。
|
||||
*/
|
||||
int IEC60870_Time_To_Seconds(const IEC60870_WallTime_t *time, uint32_t *seconds)
|
||||
{
|
||||
uint32_t result;
|
||||
|
||||
if (seconds == NULL || !WallTime_Is_Valid(time)) {
|
||||
return 0;
|
||||
}
|
||||
result = Seconds_From_Civil(time);
|
||||
*seconds = result;
|
||||
return 1;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将 UTC 纪元秒数和毫秒余数还原为完整公历时间。
|
||||
* 入口参数:seconds——0..IEC60870_TIME_MAX_SECONDS;ms——0..999。
|
||||
* 出口参数:time——接收 UTC 年月日、时分秒、毫秒及重新计算的 weekday。
|
||||
* 返回值:1 成功;0 参数非法或平台转换失败,失败时输出不变,不对越界毫秒进行截断或进位。
|
||||
* 说明:编译时选择平台库或整数算法;使用局部结果,全部完成后才写回调用方输出。
|
||||
*/
|
||||
int IEC60870_Time_From_Seconds(uint32_t seconds, uint16_t ms, IEC60870_WallTime_t *time)
|
||||
{
|
||||
IEC60870_WallTime_t result = {0};
|
||||
#if IEC60870_TIME_USE_PLATFORM
|
||||
__time64_t stamp;
|
||||
struct tm utc;
|
||||
#else
|
||||
uint32_t days, rem, z, era, doe, yoe, doy, mp, month, year;
|
||||
#endif
|
||||
|
||||
if (time == NULL || seconds > IEC60870_TIME_MAX_SECONDS || ms > 999U) {
|
||||
return 0;
|
||||
}
|
||||
#if IEC60870_TIME_USE_PLATFORM
|
||||
/* 显式使用 64 位接口,避免 32 位 time_t 的 2038 年上限;转换结果始终为 UTC。 */
|
||||
stamp = (__time64_t)seconds;
|
||||
if (_gmtime64_s(&utc, &stamp) != 0) {
|
||||
return 0;
|
||||
}
|
||||
result.year = (uint16_t)(utc.tm_year + 1900);
|
||||
result.month = (uint8_t)(utc.tm_mon + 1);
|
||||
result.day = (uint8_t)utc.tm_mday;
|
||||
result.hour = (uint8_t)utc.tm_hour;
|
||||
result.minute = (uint8_t)utc.tm_min;
|
||||
result.second = (uint8_t)utc.tm_sec;
|
||||
result.weekday = (uint8_t)utc.tm_wday;
|
||||
#else
|
||||
/* 先分成完整天数和日内秒数,日期换算与时分秒拆分分别进行。 */
|
||||
days = seconds / 86400U;
|
||||
rem = seconds % 86400U;
|
||||
/*
|
||||
* 与 Days_From_Civil 反向对应:先恢复以三月为年首的天数,再求 400 年周期及周期内年份。
|
||||
* yoe 中的修正项处理闰日、世纪和周期末日,避免将周期最后一天归入下一周期。
|
||||
* mp 先得到从三月起算的月份编号,再还原为 1..12;一、二月归回下一公历年。
|
||||
*/
|
||||
z = days + 719468U;
|
||||
era = z / 146097U;
|
||||
doe = z - era * 146097U;
|
||||
yoe = (doe - doe / 1460U + doe / 36524U - doe / 146096U) / 365U;
|
||||
doy = doe - (365U * yoe + yoe / 4U - yoe / 100U);
|
||||
mp = (5U * doy + 2U) / 153U;
|
||||
month = (mp < 10U) ? (mp + 3U) : (mp - 9U);
|
||||
year = yoe + era * 400U + ((month <= 2U) ? 1U : 0U);
|
||||
|
||||
result.year = (uint16_t)year;
|
||||
result.month = (uint8_t)month;
|
||||
result.day = (uint8_t)(doy - (153U * mp + 2U) / 5U + 1U);
|
||||
result.hour = (uint8_t)(rem / 3600U);
|
||||
result.minute = (uint8_t)((rem % 3600U) / 60U);
|
||||
result.second = (uint8_t)(rem % 60U);
|
||||
result.weekday = Weekday_From_Days(days);
|
||||
#endif
|
||||
result.ms = ms;
|
||||
*time = result;
|
||||
return 1;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将 UTC 纪元秒数和毫秒直接展开为固定 UTC+8 的本地标准时间。
|
||||
* 入口参数:utc_seconds——未加时区偏移的 UTC 纪元秒数;ms——0..999。
|
||||
* 出口参数:local_time——本地年月日、时分秒、毫秒及重新计算的星期。
|
||||
* 返回值:1 成功;0 参数非法、本地日期超出 1970..2099 或平台转换失败,失败时输出不变。
|
||||
* 说明:先检查再平移秒数,只展开一次日历;调用方无需手动调整小时、日期或星期。
|
||||
*/
|
||||
int IEC60870_Time_Seconds_To_Local(uint32_t utc_seconds, uint16_t ms,
|
||||
IEC60870_WallTime_t *local_time)
|
||||
{
|
||||
const uint32_t local_offset_seconds = (uint32_t)IEC60870_LOCAL_UTC_OFFSET_MINUTES * 60U;
|
||||
|
||||
if (local_time == NULL || ms > 999U ||
|
||||
utc_seconds > IEC60870_TIME_MAX_SECONDS - local_offset_seconds) {
|
||||
return 0;
|
||||
}
|
||||
/* 平移值只用于展开本地日历,不作为新的 UTC 时间戳保存或返回。 */
|
||||
return IEC60870_Time_From_Seconds(utc_seconds + local_offset_seconds, ms, local_time);
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将源日历、SU 和源标准时区一起换算为有效的 UTC 纪元秒数。
|
||||
* 入口参数:value——合法的 2000..2099 年 CP56 解析值,IV=0,SU/has_weekday 为 0/1;
|
||||
* standard_utc_offset_minutes——源标准当地时间减 UTC 的分钟数,范围 -1439..1439,
|
||||
* 不包含夏令时;源标准时区 UTC+8 填 480,即使 SU=1 也不改变该偏移。
|
||||
* 出口参数:seconds——接收 UTC 完整秒数,毫秒仍由输入日历保存。
|
||||
* 返回值:1 成功;0 参数非法、IV=1 或结果越界,失败时输出不变。
|
||||
* 说明:原始解码尚未修正 SU;在本函数中扣除一小时后,不应再由业务重复扣减。
|
||||
*/
|
||||
int IEC60870_Time_CP56_To_Seconds(const IEC60870_CP56Time2a_t *value,
|
||||
int16_t standard_utc_offset_minutes, uint32_t *seconds)
|
||||
{
|
||||
int64_t utc_seconds;
|
||||
|
||||
/*
|
||||
* 标准时区偏移不包含夏令时,绝对值须小于一天;这是本接口的参数范围。
|
||||
* IV=1 的时间可被原始编解码保留,但不能在这里作为有效时间转换;SU=1 则正常参与换算。
|
||||
*/
|
||||
if (value == NULL || seconds == NULL || !WallTime_Is_Valid(&value->time) ||
|
||||
value->time.year < IEC60870_CP56_MIN_YEAR || value->time.year > IEC60870_CP56_MAX_YEAR ||
|
||||
value->is_invalid != 0U || value->is_summer_time > 1U || value->has_weekday > 1U ||
|
||||
standard_utc_offset_minutes < -1439 || standard_utc_offset_minutes > 1439) {
|
||||
return 0;
|
||||
}
|
||||
/*
|
||||
* 标准时间 = 报文日历 - SU * 3600;UTC = 标准时间 - 标准时区偏移。
|
||||
* 在秒数上调整可跨日/月/年;有符号 64 位中间值避免 2038 年问题及加减回绕。
|
||||
* 原日历和 SU 保持配套,不能先改小时再保留 SU,否则再次换算会重复扣减。
|
||||
*/
|
||||
utc_seconds = (int64_t)Seconds_From_Civil(&value->time) -
|
||||
(int64_t)value->is_summer_time * INT64_C(3600) -
|
||||
(int64_t)standard_utc_offset_minutes * INT64_C(60);
|
||||
/* 在有符号域中检查最终值,再转 uint32_t,避免负数或超范围结果被当成有效纪元秒数。 */
|
||||
if (utc_seconds < 0 || utc_seconds > (int64_t)IEC60870_TIME_MAX_SECONDS) {
|
||||
return 0;
|
||||
}
|
||||
/* 读取输入和检查结果范围后才提交输出;毫秒余数仍取 value->time.ms。 */
|
||||
*seconds = (uint32_t)utc_seconds;
|
||||
return 1;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将 CP56 解析值转换为固定 UTC+8 的本地标准时间日历。
|
||||
* 入口参数:value——合法 CP56 解析值,须保留配套的源日历及 IV/SU;
|
||||
* source_standard_utc_offset_minutes——源标准时区偏移,单位为分钟,范围 -1439..1439,
|
||||
* 不包含夏令时;源标准时区与本地相同时传 IEC60870_LOCAL_UTC_OFFSET_MINUTES。
|
||||
* 出口参数:local_time——接收本地标准时间年月日、时分秒、毫秒和重新计算的星期。
|
||||
* 返回值:1 成功;0 参数非法、IV=1、转换结果越界或平台转换失败,失败时输出不变。
|
||||
* 说明:通常在 From_CP56 成功后调用;输出已处理 SU 和时区,业务不再加八小时或减一小时。
|
||||
*/
|
||||
int IEC60870_Time_CP56_To_Local(const IEC60870_CP56Time2a_t *value,
|
||||
int16_t source_standard_utc_offset_minutes,
|
||||
IEC60870_WallTime_t *local_time)
|
||||
{
|
||||
uint32_t utc_seconds;
|
||||
|
||||
/* 下层已统一检查 IV、SU、源偏移和日期,并完成夏令时修正;本层不再重复扣除一小时。 */
|
||||
if (local_time == NULL ||
|
||||
!IEC60870_Time_CP56_To_Seconds(value, source_standard_utc_offset_minutes, &utc_seconds)) {
|
||||
return 0;
|
||||
}
|
||||
/* 与直接从时间戳取本地时间共用入口,统一处理上限、跨日/月/年和星期。 */
|
||||
return IEC60870_Time_Seconds_To_Local(utc_seconds, value->time.ms, local_time);
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:将日历及 IV/SU/星期标志编码为七字节 CP56Time2a。
|
||||
* 入口参数:value——合法的 2000..2099 年日历,三个标志均为 0/1;
|
||||
* capacity——out 的实际可写字节数,至少 IEC60870_CP56_LEN。
|
||||
* 出口参数:out——只写前七字节,超出部分保持原样。
|
||||
* 返回值:1 成功;0 参数非法,失败时整个输出缓冲区不变。
|
||||
* 说明:公共编码只校验并写入日历和标志;业务发送统一设置 SU=0 的约束由后续业务入口落实。
|
||||
*/
|
||||
int IEC60870_Time_To_CP56(const IEC60870_CP56Time2a_t *value, uint8_t *out, size_t capacity)
|
||||
{
|
||||
uint8_t encoded[IEC60870_CP56_LEN];
|
||||
uint8_t weekday = 0U;
|
||||
uint16_t msec;
|
||||
|
||||
if (value == NULL || out == NULL || capacity < IEC60870_CP56_LEN ||
|
||||
!WallTime_Is_Valid(&value->time) ||
|
||||
value->time.year < IEC60870_CP56_MIN_YEAR || value->time.year > IEC60870_CP56_MAX_YEAR ||
|
||||
value->is_invalid > 1U || value->is_summer_time > 1U || value->has_weekday > 1U) {
|
||||
return 0;
|
||||
}
|
||||
/* 报文星期 0 表示未使用;携带星期时由日期重算,将内存中的周日 0 转成报文值 7。 */
|
||||
if (value->has_weekday != 0U) {
|
||||
weekday = Weekday_From_Days(Days_From_Civil(value->time.year, value->time.month, value->time.day));
|
||||
weekday = (uint8_t)((weekday == 0U) ? 7U : weekday);
|
||||
}
|
||||
/* CP56 前两字节保存分钟内毫秒,范围 0..59999,由秒和毫秒余数组合而成。 */
|
||||
msec = (uint16_t)((uint32_t)value->time.second * 1000U + value->time.ms);
|
||||
/* 逐字节布局,不把结构体转成报文,也不要求输出缓冲区对齐。 */
|
||||
encoded[0] = (uint8_t)(msec & 0xFFU);
|
||||
encoded[1] = (uint8_t)(msec >> 8);
|
||||
encoded[2] = (uint8_t)(value->time.minute | (uint8_t)(value->is_invalid << 7));
|
||||
/*
|
||||
* SU 按输入写入 bit7,不改变小时值;小时字段及 SU 已校验,保留位保持为 0。
|
||||
* 这里不能直接清除 SU=1:若小时仍是夏令时值,单独清标志会改变报文所表达的时刻。
|
||||
*/
|
||||
encoded[3] = (uint8_t)(value->time.hour | (uint8_t)(value->is_summer_time << 7));
|
||||
/* 日号占低五位、星期占高三位;月份和两位年份单独存储,未使用的高位保持为 0。 */
|
||||
encoded[4] = (uint8_t)(value->time.day | (uint8_t)(weekday << 5));
|
||||
encoded[5] = value->time.month;
|
||||
encoded[6] = (uint8_t)(value->time.year - IEC60870_CP56_MIN_YEAR);
|
||||
/* 校验和读取输入完成后才统一提交输出;也允许 out 与 value 的存储重叠。 */
|
||||
memcpy(out, encoded, IEC60870_CP56_LEN);
|
||||
return 1;
|
||||
}
|
||||
|
||||
/*
|
||||
* 函数功能:校验并解码前七字节 CP56Time2a,保留源日历及 IV/SU。
|
||||
* 入口参数:in——报文起点;length——实际可读字节数,至少 IEC60870_CP56_LEN。
|
||||
* 出口参数:value——接收日历、IV、SU 和是否携带星期;weekday 始终按日期重新计算。
|
||||
* 返回值:1 成功;0 指针、长度、保留位、日期时间或非零星期不合法,失败时输出不变。
|
||||
* 说明:后续字节不处理;SU=1 或 IV=1 本身不导致解码失败,仍要求日期及其余字段合法。
|
||||
* 成功只表示满足格式约束,尚未进行时间转换,也不表示该时间可以用于校时。
|
||||
*/
|
||||
int IEC60870_Time_From_CP56(const uint8_t *in, size_t length, IEC60870_CP56Time2a_t *value)
|
||||
{
|
||||
IEC60870_CP56Time2a_t result = {0};
|
||||
uint16_t msec;
|
||||
uint8_t received_weekday, expected_weekday;
|
||||
|
||||
if (in == NULL || value == NULL || length < IEC60870_CP56_LEN) {
|
||||
return 0;
|
||||
}
|
||||
/*
|
||||
* 本模块要求分钟 bit6、小时 bit5..6、月份 bit4..7、年份 bit7 为 0。
|
||||
* 非零保留位直接拒绝,不能用掩码静默丢弃;IV 和 SU 为有效标志,另外提取。
|
||||
*/
|
||||
if ((in[2] & 0x40U) != 0U || (in[3] & 0x60U) != 0U ||
|
||||
(in[5] & 0xF0U) != 0U || (in[6] & 0x80U) != 0U) {
|
||||
return 0;
|
||||
}
|
||||
/* 按低字节在前还原分钟内毫秒;超过 59999 不能表示合法的秒与毫秒余数。 */
|
||||
msec = (uint16_t)((uint16_t)in[0] | ((uint16_t)in[1] << 8));
|
||||
if (msec > 59999U) {
|
||||
return 0;
|
||||
}
|
||||
result.time.year = (uint16_t)(IEC60870_CP56_MIN_YEAR + in[6]);
|
||||
result.time.month = (uint8_t)(in[5] & 0x0FU);
|
||||
result.time.day = (uint8_t)(in[4] & 0x1FU);
|
||||
result.time.hour = (uint8_t)(in[3] & 0x1FU);
|
||||
result.time.minute = (uint8_t)(in[2] & 0x3FU);
|
||||
result.time.second = (uint8_t)(msec / 1000U);
|
||||
result.time.ms = (uint16_t)(msec % 1000U);
|
||||
result.is_invalid = (uint8_t)((in[2] >> 7) & 1U);
|
||||
/* 与原始小时配套保留 SU,交给后续转换接口处理,避免丢失信息或重复扣除一小时。 */
|
||||
result.is_summer_time = (uint8_t)((in[3] >> 7) & 1U);
|
||||
/* 报文星期 0 表示未提供星期;内存中的 weekday=0 表示周日,需由 has_weekday 区分。 */
|
||||
received_weekday = (uint8_t)(in[4] >> 5);
|
||||
result.has_weekday = (uint8_t)(received_weekday != 0U);
|
||||
/* 年份 100..127 会展开为 2100..2127,在此随其他无效日期一起拒绝,不自动映射世纪。 */
|
||||
if (!WallTime_Is_Valid(&result.time)) {
|
||||
return 0;
|
||||
}
|
||||
/* 无论报文是否携带星期,都从日期计算输出;非零报文星期还须与计算结果一致。 */
|
||||
result.time.weekday = Weekday_From_Days(Days_From_Civil(result.time.year, result.time.month,
|
||||
result.time.day));
|
||||
expected_weekday = (uint8_t)((result.time.weekday == 0U) ? 7U : result.time.weekday);
|
||||
if (received_weekday != 0U && received_weekday != expected_weekday) {
|
||||
return 0;
|
||||
}
|
||||
/*
|
||||
* IV=1 仍可供业务记录;取有效的本地标准时间时,应将完整结果交给 CP56_To_Local 检查和转换。
|
||||
* 是否允许校时、远端时间是否合理仍由业务判断,此处不设置 RTC。
|
||||
*/
|
||||
*value = result;
|
||||
return 1;
|
||||
}
|
||||
@@ -0,0 +1,244 @@
|
||||
/*
|
||||
* 模块名称:IEC 60870-5-101/104 公共时间工具
|
||||
* 模块功能:CP16/CP24/CP56编解码、公历日期/星期、本地标准时间及纪元秒数工具。
|
||||
* 适用协议:101 和 104 的时间格式共用同一实现,独立于各自的帧格式和链路层。
|
||||
* 职责边界:公共编解码保留 IV/SU,允许合法的 SU=0/1,不调整输入日历。
|
||||
* 业务接收时通过 CP56_To_Local 检查 IV、处理 SU 和源时区,取得本地标准时间日历。
|
||||
* 后续业务发送入口须保证日历已是本地标准时间,并统一设置 SU=0。
|
||||
* 接入状态:IEC60870_Asdu 已复用 CP56 编解码;事件采集、时间源读取和实际校时仍由业务接入。
|
||||
* 适用平台:可选平台库或纯整数日期转换;不读取系统时钟、不设置 RTC、不推断时区规则或处理链路定时器。
|
||||
*/
|
||||
#ifndef IEC60870_TIME_H
|
||||
#define IEC60870_TIME_H
|
||||
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* CP16为经过时间;CP24仅含分钟及分钟内毫秒,不能单独恢复完整日期。 */
|
||||
#define IEC60870_CP16_LEN 2U
|
||||
#define IEC60870_CP24_LEN 3U
|
||||
#define IEC60870_CP56_LEN 7U
|
||||
#define IEC60870_TIME_MIN_YEAR 1970U
|
||||
#define IEC60870_TIME_MAX_YEAR 2099U
|
||||
/* 两位年份按 2000 年起解释是本实现的世纪约定,须与通信对端一致。 */
|
||||
#define IEC60870_CP56_MIN_YEAR 2000U
|
||||
#define IEC60870_CP56_MAX_YEAR 2099U
|
||||
/* 2099-12-31 23:59:59 UTC;本模块不接受 uint32_t 可表示但超出约定年份的秒数。 */
|
||||
#define IEC60870_TIME_MAX_SECONDS UINT32_C(4102444799)
|
||||
/*
|
||||
* 本地标准时区固定为 UTC+8,不读取系统时区。
|
||||
* 源标准时区也为 UTC+8 时,转换接口传入此值;即使报文 SU=1,源标准偏移仍为 480。
|
||||
* 其他源时区由调用方按双方约定提供标准偏移,不能一律传入此值。
|
||||
*/
|
||||
#define IEC60870_LOCAL_UTC_OFFSET_MINUTES 480
|
||||
|
||||
/*
|
||||
* 时间戳转日历的编译选项:1 使用平台库,0 使用本模块保留的纯整数算法。
|
||||
* 当前平台库后端为 Windows CRT 的 _gmtime64_s;Windows 默认 1,其他平台默认 0。
|
||||
* 无合适时间库时,在编译 IEC60870_Time.c 时定义 IEC60870_TIME_USE_PLATFORM=0。
|
||||
* 两种实现均输出 UTC,支持相同的 1970..2099 年范围,不读取当前时间或本地时区。
|
||||
*/
|
||||
#ifndef IEC60870_TIME_USE_PLATFORM
|
||||
#ifdef _WIN32
|
||||
#define IEC60870_TIME_USE_PLATFORM 1
|
||||
#else
|
||||
#define IEC60870_TIME_USE_PLATFORM 0
|
||||
#endif
|
||||
#endif
|
||||
|
||||
typedef struct {
|
||||
uint16_t milliseconds; /* CP16经过时间,0..65535毫秒,无IV或SU。 */
|
||||
} IEC60870_CP16Time2a_t;
|
||||
|
||||
typedef struct {
|
||||
uint16_t milliseconds; /* CP24分钟内毫秒,0..59999,包含秒。 */
|
||||
uint8_t minute; /* 0..59;不含小时、日期或时区。 */
|
||||
uint8_t is_invalid; /* IV,0/1;编码和解码保留。 */
|
||||
} IEC60870_CP24Time2a_t;
|
||||
|
||||
/**
|
||||
* 功能:编码CP16经过时间或CP24短时标。
|
||||
* 输入参数:value——非空解析值;capacity——输出容量,分别至少2/3字节。
|
||||
* 输出参数:out——低字节在前的协议字节,不改变输入时间基准。
|
||||
* 返回值:1成功;0参数或字段非法,输出不变。
|
||||
* 说明:CP24保留IV但检查分钟和毫秒范围,不推断小时或日期,不携带SU。
|
||||
*/
|
||||
int IEC60870_Time_To_CP16(const IEC60870_CP16Time2a_t *value, uint8_t *out, size_t capacity);
|
||||
int IEC60870_Time_To_CP24(const IEC60870_CP24Time2a_t *value, uint8_t *out, size_t capacity);
|
||||
|
||||
/**
|
||||
* 功能:解码CP16经过时间或CP24短时标。
|
||||
* 输入参数:in——非空字节串;length——可读长度,分别至少2/3字节。
|
||||
* 输出参数:value——成功后保存独立解析值,失败不变。
|
||||
* 返回值:1成功;0参数、长度、CP24保留位或字段非法。
|
||||
* 说明:只读取前2/3字节;CP24的IV=1仍可解析,但不表示时间有效。
|
||||
*/
|
||||
int IEC60870_Time_From_CP16(const uint8_t *in, size_t length, IEC60870_CP16Time2a_t *value);
|
||||
int IEC60870_Time_From_CP24(const uint8_t *in, size_t length, IEC60870_CP24Time2a_t *value);
|
||||
|
||||
/*
|
||||
* 公历时间值,不携带时区或 SU;Seconds_To_Local、CP56_To_Local 输出本地标准时间,
|
||||
* From_Seconds 输出 UTC。
|
||||
* 调用 To_Seconds 时须提供 UTC 日历,不能把本地标准时间日历直接当成 UTC 转秒数。
|
||||
* weekday 为派生字段:0=周日,1=周一,...,6=周六。
|
||||
* 编码及转秒数时忽略传入的 weekday;解码及从秒数转换时按日期重新计算。
|
||||
* 此类型仅供内存中传值,不能直接作为 CP56Time2a 的报文字节布局。
|
||||
*/
|
||||
typedef struct {
|
||||
uint16_t year; /* 普通日历为 1970..2099;CP56 编解码限于 2000..2099 */
|
||||
uint8_t month; /* 1..12 */
|
||||
uint8_t day; /* 1..当月实际天数 */
|
||||
uint8_t hour; /* 0..23 */
|
||||
uint8_t minute; /* 0..59 */
|
||||
uint8_t second; /* 0..59,不表示闰秒 */
|
||||
uint16_t ms; /* 0..999 */
|
||||
uint8_t weekday; /* 0..6,输出时由日期推导 */
|
||||
} IEC60870_WallTime_t;
|
||||
|
||||
/*
|
||||
* CP56Time2a 的解析值;标志与普通日历值分开,避免丢失报文中的时间质量信息。
|
||||
* is_invalid、is_summer_time 和 has_weekday 只能为 0 或 1。
|
||||
* 编码由 has_weekday 决定是否携带星期,IV 和 SU 按输入保留。
|
||||
* IV=1 仍可编解码,但日期字段仍须合法;成功不表示该时间可用于校时。
|
||||
* 标准允许选用 SU 但不推荐使用;本项目后续业务发送入口负责统一设置 SU=0。
|
||||
* 公共编解码支持 SU=0/1,不强制清零;发送前须确保日历与标志一致,不能只清 SU 而保留夏令时日历。
|
||||
* SU 不携带时区信息;取本地标准时间时将完整解析值及源标准时区偏移交给 CP56_To_Local。
|
||||
*/
|
||||
typedef struct {
|
||||
IEC60870_WallTime_t time; /* 2000..2099;按双方约定的时间基准及 SU 解释 */
|
||||
uint8_t is_invalid; /* IV:1=时间无效,0=未置无效标志 */
|
||||
uint8_t is_summer_time; /* SU:0=标准时间,1=夏令时;原始编解码保留,CP56 转换接口在为 1 时扣除一小时 */
|
||||
uint8_t has_weekday; /* 1=报文带星期,0=报文星期域为 0(未使用) */
|
||||
} IEC60870_CP56Time2a_t;
|
||||
|
||||
/*
|
||||
* 所有接口:成功返回 1;参数/格式非法、结果越界、平台转换失败或将 IV=1 转为有效时间时返回 0。
|
||||
* 返回 0 时不修改任何输出;调用方仍须保证指针有效且实际空间不少于所报长度。
|
||||
* 模块不维护共享可变状态或动态内存。输入和输出允许重叠。
|
||||
* 成功写回输出时,会覆盖与输出重叠的输入存储;需要保留原始输入时应使用独立输出存储。
|
||||
*/
|
||||
|
||||
/**
|
||||
* 功能:检查日历的年月日、时分秒及毫秒是否合法,不进行时间转换。
|
||||
* 输入:time——待检查的日历值;年份1970..2099,毫秒0..999。
|
||||
* 返回:1 数值合法;0 空指针、无效日期或字段越界。
|
||||
* 说明:忽略派生字段weekday;不判断时区、时钟是否准确或是否允许校时。
|
||||
*/
|
||||
int IEC60870_Time_Is_Valid(const IEC60870_WallTime_t *time);
|
||||
|
||||
/**
|
||||
* 功能:检查公历日期并计算星期。
|
||||
* 输入:year——1970..2099;month、day——合法月份和日期。
|
||||
* 输出:weekday——0=周日,1=周一,...,6=周六。
|
||||
* 返回:1 成功;0 日期非法或输出为空,输出不变。
|
||||
*/
|
||||
int IEC60870_Time_Get_Weekday(uint16_t year, uint8_t month, uint8_t day, uint8_t *weekday);
|
||||
|
||||
/**
|
||||
* 功能:将 UTC 日期和时间转换为自 1970-01-01 00:00:00 UTC 起的完整秒数。
|
||||
* 输入:time——年份 1970..2099,毫秒 0..999,其余字段须组成合法时间。
|
||||
* 输出:seconds——0..IEC60870_TIME_MAX_SECONDS;0 是有效纪元时间,不表示失败。
|
||||
* 返回:1 成功;0 参数非法,输出不变。
|
||||
* 说明:ms 参与范围校验,但不计入完整秒数;需保留亚秒精度时另行保存 time->ms。
|
||||
* 忽略 weekday,不进行本地时区换算,也不计闰秒。
|
||||
* time 没有时区或 SU,函数无法检查其是否真的采用 UTC,须由调用方保证。
|
||||
* 对 CP56 解析值,取本地标准时间调用 CP56_To_Local;取纪元秒数调用 CP56_To_Seconds。
|
||||
*/
|
||||
int IEC60870_Time_To_Seconds(const IEC60870_WallTime_t *time, uint32_t *seconds);
|
||||
|
||||
/**
|
||||
* 功能:将纪元秒数和毫秒余数转换为 UTC 日期和时间。
|
||||
* 输入:seconds——0..IEC60870_TIME_MAX_SECONDS;ms——0..999。
|
||||
* 输出:time——完整公历时间及按日期计算的 weekday。
|
||||
* 返回:1 成功;0 参数非法或平台转换失败,输出不变;不会把越界毫秒截断成 999。
|
||||
* 说明:由 IEC60870_TIME_USE_PLATFORM 选择平台库或纯整数算法;均不做本地时区换算。
|
||||
*/
|
||||
int IEC60870_Time_From_Seconds(uint32_t seconds, uint16_t ms, IEC60870_WallTime_t *time);
|
||||
|
||||
/**
|
||||
* 功能:将 UTC 纪元秒数和毫秒余数直接转换为本地标准时间日历(固定 UTC+8)。
|
||||
* 输入:utc_seconds——未加时区偏移的 UTC 纪元秒数;ms——0..999。
|
||||
* 本地日期须在 1970..2099 年内,因此 utc_seconds 上限为
|
||||
* IEC60870_TIME_MAX_SECONDS - IEC60870_LOCAL_UTC_OFFSET_MINUTES * 60。
|
||||
* 输出:local_time——本地年月日、时分秒、毫秒及重新计算的星期。
|
||||
* 返回:1 成功;0 参数非法、本地日期越界或平台转换失败,输出不变。
|
||||
* 说明:内部统一处理时区偏移及跨日/月/年,调用方不再加八小时。
|
||||
* 不读取系统时区或开启夏令时;已是固定 UTC+8 标准时间的 RTC 日历可直接用于 CP56 编码。
|
||||
*/
|
||||
int IEC60870_Time_Seconds_To_Local(uint32_t utc_seconds, uint16_t ms,
|
||||
IEC60870_WallTime_t *local_time);
|
||||
|
||||
/**
|
||||
* 功能:将 CP56Time2a 解析值转换为 UTC 纪元完整秒数,SU=1 时扣除一小时。
|
||||
* 输入:value——合法的 2000..2099 年日期时间,IV=0,SU/has_weekday 为 0/1;
|
||||
* standard_utc_offset_minutes——源报文标准当地时间减 UTC 的分钟数,范围 -1439..1439,
|
||||
* 向东为正、向西为负;UTC 填 0,UTC+8 填 480,UTC-5 填 -300。
|
||||
* 此偏移必须不含夏令时的一小时;SU 会单独扣除,不能重复计算。
|
||||
* 输出:seconds——0..IEC60870_TIME_MAX_SECONDS 的 UTC 秒数。
|
||||
* 返回:1 成功;0 参数非法、IV=1 或换算结果越界,输出不变。
|
||||
* 说明:UTC = 报文日历对应秒数 - SU * 3600 - 标准时区偏移 * 60。
|
||||
* 在秒数上运算,支持跨日/月/年;年份 2000 的输入可换算为 1999 年的 UTC。
|
||||
* ms 校验后不计入完整秒数;未与输出重叠时,输入日期、SU 和毫秒均保持不变。
|
||||
* 忽略传入的 weekday;不根据日期猜测夏令时,不访问系统时区或设置 RTC。
|
||||
*/
|
||||
int IEC60870_Time_CP56_To_Seconds(const IEC60870_CP56Time2a_t *value,
|
||||
int16_t standard_utc_offset_minutes, uint32_t *seconds);
|
||||
|
||||
/**
|
||||
* 功能:将 CP56Time2a 解析值转换为本地标准时间日历(固定 UTC+8),并处理 SU。
|
||||
* 输入:value——合法的 2000..2099 年日期时间,IV=0,SU/has_weekday 为 0/1;
|
||||
* source_standard_utc_offset_minutes——源报文标准当地时间减 UTC 的分钟数,
|
||||
* 范围 -1439..1439,不含夏令时;双方约定本地标准时间时传
|
||||
* IEC60870_LOCAL_UTC_OFFSET_MINUTES(480),源报文为 UTC 时传 0。
|
||||
* 输出:local_time——1970..2099 年的本地标准时间年月日、时分秒、毫秒及重新计算的星期。
|
||||
* 返回:1 成功;0 参数非法、IV=1、本地标准时间越界或平台转换失败,输出不变。
|
||||
* 说明:本地标准时间 = 报文日历 - SU * 一小时 - 源标准时区偏移 + 八小时。
|
||||
* 源标准时区为 UTC+8 时,SU=0 保持原时间,SU=1 减一小时,自动处理跨日/月/年。
|
||||
* 毫秒原样保留;日历结果通过 local_time 输出,函数返回值仅表示成功或失败。
|
||||
* 输入与输出未重叠时,不改写输入日历或 SU。
|
||||
* 结果已是本地标准时间,调用方无需再次加八小时或减夏令时的一小时。
|
||||
* 业务再次发送此日历时应构造新的 CP56 值并置 SU=0,不能沿用原报文的 SU=1。
|
||||
*/
|
||||
int IEC60870_Time_CP56_To_Local(const IEC60870_CP56Time2a_t *value,
|
||||
int16_t source_standard_utc_offset_minutes,
|
||||
IEC60870_WallTime_t *local_time);
|
||||
|
||||
/**
|
||||
* 功能:将 CP56Time2a 解析值编码为 7 字节报文,毫秒域按低字节在前写入。
|
||||
* 输入:value——合法的 2000..2099 年日期时间,三个标志字段均为 0/1;
|
||||
* capacity——out 可写字节数,至少 IEC60870_CP56_LEN。
|
||||
* 输出:out——仅写前 7 字节,保留位清零,IV 和 SU 按输入保留。
|
||||
* 返回:1 成功;0 参数非法,整个输出缓冲区不变。
|
||||
* 说明:has_weekday=1 时由日期计算报文星期(1=周一..7=周日),否则填 0。
|
||||
* 不校时、不转换时区,也不因 SU=1 而调整小时值。
|
||||
* SU=0/1 均可编码,本接口不会自动清零或因 SU=1 而拒绝合法输入。
|
||||
* 后续业务发送入口负责传入已是本地标准时间的日历并设置 SU=0;此处只执行公共编码。
|
||||
* IV=1 不放宽日期、时间及标志取值的检查。
|
||||
*/
|
||||
int IEC60870_Time_To_CP56(const IEC60870_CP56Time2a_t *value, uint8_t *out, size_t capacity);
|
||||
|
||||
/**
|
||||
* 功能:检查并解析前 7 字节 CP56Time2a,后续字节留给调用方处理。
|
||||
* 输入:in——报文起点;length——可读字节数,至少 IEC60870_CP56_LEN。
|
||||
* 输出:value——源报文的日历时间、IV、SU 及报文是否携带星期,尚未转换为本地标准时间;
|
||||
* weekday 始终由日期计算。
|
||||
* 返回:1 成功;0 参数、保留位、日期时间非法,输出不变。
|
||||
* 说明:年份域只接受 0..99,解释为 2000..2099;星期域 0 表示未使用,
|
||||
* 非零星期必须与日期一致。分钟 bit6 等保留位必须为 0,不接收扩展含义。
|
||||
* SU=1 本身不导致失败,IV/SU 均原样返回;不转换时区或夏令时。
|
||||
* IV=1 且其余字段合法时仍可成功解析,供业务记录;两个 CP56 转换接口会拒绝该无效时间。
|
||||
* 解码后取本地标准时间调用 CP56_To_Local;需要纪元秒数时调用 CP56_To_Seconds。
|
||||
* 转换前须保留完整的日历及 SU,不可先清 SU,也不可先减一小时再携带 SU=1 转换。
|
||||
* 业务仍须检查时间约定及校时权限;不自动设置 RTC。
|
||||
*/
|
||||
int IEC60870_Time_From_CP56(const uint8_t *in, size_t length, IEC60870_CP56Time2a_t *value);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* IEC60870_TIME_H */
|
||||
@@ -0,0 +1,29 @@
|
||||
/*
|
||||
* 101/104共用的应用层值类型:ASDU字段宽度和总长上限。
|
||||
* 只依赖标准整数类型,不包含传输帧、连接、队列或平台接口。
|
||||
* 调用方按接入协议显式选择参数;104的默认配置由104接入层提供。
|
||||
*/
|
||||
#ifndef IEC60870_TYPES_H
|
||||
#define IEC60870_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#define IEC60870_MAX_ASDU_LEN 254 /* 通用101/104 ASDU存储上限;104传输仍限249。 */
|
||||
|
||||
/* 应用层参数描述ASDU字段宽度及长度上限,字段使用int以便校验原始范围。
|
||||
* Type ID/VSQ固定为1字节;COT/CA可为1或2字节,IOA可为1、2或3字节。
|
||||
* 通用ASDU上限为254;接入本工程104 TCP时使用2/2/3及不超过249的上限。
|
||||
* 参数由调用方持有,构造器及解析视图借用它;使用期间必须有效且不可修改。
|
||||
* originatorAddress供业务作为发送OA的默认值,报文构造仍以header中显式OA为准;
|
||||
* COT为1字节时不编码OA,解析得到的OA为0。配置需要双方一致,不自动协商。 */
|
||||
typedef struct {
|
||||
int sizeOfTypeId; /* 固定1,不支持修改。 */
|
||||
int sizeOfVSQ; /* 固定1,不支持修改。 */
|
||||
int sizeOfCOT; /* 1或2;2字节时包含OA。 */
|
||||
int originatorAddress; /* 业务默认源发地址,0..255。 */
|
||||
int sizeOfCA; /* 公共地址长度,1或2。 */
|
||||
int sizeOfIOA; /* 信息对象地址长度,1、2或3。 */
|
||||
int maxSizeOfASDU; /* 包含公共头;至少容纳头,最多254。 */
|
||||
} IEC60870_AppLayerParameters_t;
|
||||
|
||||
#endif /* IEC60870_TYPES_H */
|
||||
Reference in New Issue
Block a user