ICS-Microprocessor-2020/Display_Avr_3
5
0
Fork 0
Code Issues 6 Pull Requests Projects Releases Wiki Activity

add hdlc protocol, need test

Browse Source
This commit is contained in:
Qukich 2023-05-24 18:09:43 +03:00
parent d71e47036c
commit c82c3b11cb
5 changed files with 426 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.idea/Display_Avr_3.iml generated
View File

@ -1,8 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="CPP_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>

35
hdlc/fcs.c Normal file
View File

@ -0,0 +1,35 @@
#include "fcs.h"
static const unsigned short fcstab[256] = { 0x0000, 0x1189, 0x2312, 0x329b,
0x4624, 0x57ad, 0x6536, 0x74bf, 0x8c48, 0x9dc1, 0xaf5a, 0xbed3, 0xca6c,
0xdbe5, 0xe97e, 0xf8f7, 0x1081, 0x0108, 0x3393, 0x221a, 0x56a5, 0x472c,
0x75b7, 0x643e, 0x9cc9, 0x8d40, 0xbfdb, 0xae52, 0xdaed, 0xcb64, 0xf9ff,
0xe876, 0x2102, 0x308b, 0x0210, 0x1399, 0x6726, 0x76af, 0x4434, 0x55bd,
0xad4a, 0xbcc3, 0x8e58, 0x9fd1, 0xeb6e, 0xfae7, 0xc87c, 0xd9f5, 0x3183,
0x200a, 0x1291, 0x0318, 0x77a7, 0x662e, 0x54b5, 0x453c, 0xbdcb, 0xac42,
0x9ed9, 0x8f50, 0xfbef, 0xea66, 0xd8fd, 0xc974, 0x4204, 0x538d, 0x6116,
0x709f, 0x0420, 0x15a9, 0x2732, 0x36bb, 0xce4c, 0xdfc5, 0xed5e, 0xfcd7,
0x8868, 0x99e1, 0xab7a, 0xbaf3, 0x5285, 0x430c, 0x7197, 0x601e, 0x14a1,
0x0528, 0x37b3, 0x263a, 0xdecd, 0xcf44, 0xfddf, 0xec56, 0x98e9, 0x8960,
0xbbfb, 0xaa72, 0x6306, 0x728f, 0x4014, 0x519d, 0x2522, 0x34ab, 0x0630,
0x17b9, 0xef4e, 0xfec7, 0xcc5c, 0xddd5, 0xa96a, 0xb8e3, 0x8a78, 0x9bf1,
0x7387, 0x620e, 0x5095, 0x411c, 0x35a3, 0x242a, 0x16b1, 0x0738, 0xffcf,
0xee46, 0xdcdd, 0xcd54, 0xb9eb, 0xa862, 0x9af9, 0x8b70, 0x8408, 0x9581,
0xa71a, 0xb693, 0xc22c, 0xd3a5, 0xe13e, 0xf0b7, 0x0840, 0x19c9, 0x2b52,
0x3adb, 0x4e64, 0x5fed, 0x6d76, 0x7cff, 0x9489, 0x8500, 0xb79b, 0xa612,
0xd2ad, 0xc324, 0xf1bf, 0xe036, 0x18c1, 0x0948, 0x3bd3, 0x2a5a, 0x5ee5,
0x4f6c, 0x7df7, 0x6c7e, 0xa50a, 0xb483, 0x8618, 0x9791, 0xe32e, 0xf2a7,
0xc03c, 0xd1b5, 0x2942, 0x38cb, 0x0a50, 0x1bd9, 0x6f66, 0x7eef, 0x4c74,
0x5dfd, 0xb58b, 0xa402, 0x9699, 0x8710, 0xf3af, 0xe226, 0xd0bd, 0xc134,
0x39c3, 0x284a, 0x1ad1, 0x0b58, 0x7fe7, 0x6e6e, 0x5cf5, 0x4d7c, 0xc60c,
0xd785, 0xe51e, 0xf497, 0x8028, 0x91a1, 0xa33a, 0xb2b3, 0x4a44, 0x5bcd,
0x6956, 0x78df, 0x0c60, 0x1de9, 0x2f72, 0x3efb, 0xd68d, 0xc704, 0xf59f,
0xe416, 0x90a9, 0x8120, 0xb3bb, 0xa232, 0x5ac5, 0x4b4c, 0x79d7, 0x685e,
0x1ce1, 0x0d68, 0x3ff3, 0x2e7a, 0xe70e, 0xf687, 0xc41c, 0xd595, 0xa12a,
0xb0a3, 0x8238, 0x93b1, 0x6b46, 0x7acf, 0x4854, 0x59dd, 0x2d62, 0x3ceb,
0x0e70, 0x1ff9, 0xf78f, 0xe606, 0xd49d, 0xc514, 0xb1ab, 0xa022, 0x92b9,
0x8330, 0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78 };
FCS_SIZE calc_fcs(FCS_SIZE fcs, unsigned char value) {
return (fcs >> 8) ^ fcstab[(fcs ^ value) & 0xff];
}

25
hdlc/fcs.h Normal file
View File

@ -0,0 +1,25 @@
#ifndef FCS_H
#define FCS_H
#ifdef CRC32
#define FCS_INIT_VALUE 0xFFFFFFFF /* FCS initialization value. */
#define FCS_GOOD_VALUE 0xDEBB20E3 /* FCS value for valid frames. */
#define FCS_INVERT_MASK 0xFFFFFFFF /* Invert the FCS value accordingly to the specification */
#define FCS_SIZE unsigned int
#else
#define FCS_INIT_VALUE 0xFFFF /* FCS initialization value. */
#define FCS_GOOD_VALUE 0xF0B8 /* FCS value for valid frames. */
#define FCS_INVERT_MASK 0xFFFF /* Invert the FCS value accordingly to the specification */
#define FCS_SIZE unsigned short
#endif
/**
* Вычисляет новый Frame Check Sequence на основе текущего значения и ценности данных.
*
* @param fcs Current FCS value
* @param value The value to be added
* @returns Calculated FCS value
*/
FCS_SIZE calc_fcs(FCS_SIZE fcs, unsigned char value);
#endif //FCS_H

289
hdlc/hdlc.c
View File

@ -1,60 +1,257 @@
#include "hdlc.h"
#include <string.h>
#include "setup.h"
#define HDLC_CONTROL_S_OR_U_FRAME_BIT 0
#define HDLC_CONTROL_SEND_SEQ_NO_BIT 1
#define HDLC_CONTROL_S_FRAME_TYPE_BIT 2
#define HDLC_CONTROL_POLL_BIT 4
#define HDLC_CONTROL_RECV_SEQ_NO_BIT 5
__weak void uart_putchar(char ch)
{
// implement function to send character via UART
// HDLC Control type definitions
#define HDLC_CONTROL_TYPE_RECEIVE_READY 0
#define HDLC_CONTROL_TYPE_RECEIVE_NOT_READY 1
#define HDLC_CONTROL_TYPE_REJECT 2
#define HDLC_CONTROL_TYPE_SELECTIVE_REJECT 3
static hdlc_state_t hdlc_state = {
.control_escape = 0,
.fcs = FCS_INIT_VALUE,
.start_index = -1,
.end_index = -1,
.src_index = 0,
.dest_index = 0,
};
int hdlc_set_state(hdlc_state_t *state) {
if (!state) {
return -EINVAL;
}
static hdlc_t hdlc;
// Static buffer allocations
static uint8_t _hdlc_rx_frame[HDLC_MRU]; // rx frame buffer allocation
static uint8_t _hdlc_tx_frame[HDLC_MRU]; // tx frame buffer allocation
static uint8_t _hdlc_payload[HDLC_MRU]; // payload buffer allocation
/** Приватная функция для отправки байтов по uart */
static void hdlc_tx_byte(uint8_t byte)
{
uart_putchar((char)byte);
hdlc_state = *state;
return 0;
}
/* инициализация конечного автомата HDLC, указателей буфера и переменных состояния */
void hdlc_init(void)
{
hdlc.rx_frame_index = 0;
hdlc.rx_frame_fcs = HDLC_CRC_INIT_VAL;
hdlc.p_rx_frame = _hdlc_rx_frame;
memset(hdlc.p_rx_frame, 0, HDLC_MRU);
hdlc.p_tx_frame = _hdlc_tx_frame;
memset(hdlc.p_tx_frame, 0, HDLC_MRU);
hdlc.p_payload = _hdlc_payload;
memset(hdlc.p_payload, 0, HDLC_MRU);
hdlc.state = HDLC_SOF_WAIT;
hdlc.own_addr = SETUP_OWNADDRESS;
int hdlc_get_state(hdlc_state_t *state) {
if (!state) {
return -EINVAL;
}
//Эта функция должна вызываться при получении нового символа через UART
static void hdlc_esc_tx_byte(uint8_t byte)
{
if((byte == HDLC_CONTROL_ESCAPE) || (byte == HDLC_FLAG_SOF))
{
hdlc_tx_byte(HDLC_CONTROL_ESCAPE);
byte ^= HDLC_ESCAPE_BIT;
hdlc_tx_byte(byte);
}
else
hdlc_tx_byte(byte);
*state = hdlc_state;
return 0;
}
void hdlc_process_rx_frame(uint8_t *buf, uint16_t len){
return;
void hdlc_escape_value(char value, char *dest, int *dest_index) {
// Проверяет и экранируйте значение, если это необходимо
if ((value == HDLC_FLAG_SEQUENCE) || (value == HDLC_CONTROL_ESCAPE)) {
dest[(*dest_index)++] = HDLC_CONTROL_ESCAPE;
value ^= 0x20;
}
void hdlc_tx_frame(const uint8_t *txbuffer, uint8_t len){
return;
// Добавляет значение в буфер назначения и увеличьте индекс назначения
dest[(*dest_index)++] = value;
}
hdlc_control_t hdlc_get_control_type(unsigned char control) {
hdlc_control_t value;
// Проверяет, является ли S-фреймом (или U-фреймом)
if (control & (1 << HDLC_CONTROL_S_OR_U_FRAME_BIT)) {
// Проверяет, есть ли S-фрейм тип в Receive Ready (ACK)
if (((control >> HDLC_CONTROL_S_FRAME_TYPE_BIT) & 0x3)
== HDLC_CONTROL_TYPE_RECEIVE_READY) {
value.frame = HDLC_FRAME_ACK;
} else {
// Предположим, что это отрицательное подтверждение (NACK), так как функции "Receive Not Ready", "Selective Reject" и U-фреймы не поддерживаются.
value.frame = HDLC_FRAME_NACK;
}
// Добавляет номер последовательности приема из S-фрейма (или U-фрейма).
value.seq_no = (control >> HDLC_CONTROL_RECV_SEQ_NO_BIT);
} else {
// Должен быть I-фрейм, поэтому добавляет номер последовательности отправки (номер последовательности приема не используется).
value.frame = HDLC_FRAME_DATA;
value.seq_no = (control >> HDLC_CONTROL_SEND_SEQ_NO_BIT);
}
return value;
}
unsigned char hdlc_frame_control_type(hdlc_control_t *control) {
unsigned char value = 0;
switch (control->frame) {
case HDLC_FRAME_DATA:
// Создает байт управления HDLC I-фрейма с установленным битом опроса.
value |= (control->seq_no << HDLC_CONTROL_SEND_SEQ_NO_BIT);
value |= (1 << HDLC_CONTROL_POLL_BIT);
break;
case HDLC_FRAME_ACK:
// Создает байт управления HDLC S-фрейма "Receive Ready" с сброшенным битом опроса.
value |= (control->seq_no << HDLC_CONTROL_RECV_SEQ_NO_BIT);
value |= (1 << HDLC_CONTROL_S_OR_U_FRAME_BIT);
break;
case HDLC_FRAME_NACK:
// Создает байт управления HDLC S-фрейма "Receive Ready" с сброшенным битом опроса.
value |= (control->seq_no << HDLC_CONTROL_RECV_SEQ_NO_BIT);
value |= (HDLC_CONTROL_TYPE_REJECT << HDLC_CONTROL_S_FRAME_TYPE_BIT);
value |= (1 << HDLC_CONTROL_S_OR_U_FRAME_BIT);
break;
}
return value;
}
void hdlc_get_data_reset() {
hdlc_get_data_reset_with_state(&hdlc_state);
}
void hdlc_get_data_reset_with_state(hdlc_state_t *state) {
state->fcs = FCS_INIT_VALUE;
state->start_index = state->end_index = -1;
state->src_index = state->dest_index = 0;
state->control_escape = 0;
}
int hdlc_get_data(hdlc_control_t *control, const char *src,
unsigned int src_len, char *dest, unsigned int *dest_len) {
return hdlc_get_data_with_state(&hdlc_state, control, src, src_len, dest, dest_len);
}
int hdlc_get_data_with_state(hdlc_state_t *state, hdlc_control_t *control, const char *src,
unsigned int src_len, char *dest, unsigned int *dest_len) {
int ret;
char value;
unsigned int i;
// Проверка, что все параметры валидны
if (!state || !control || !src || !dest || !dest_len) {
return -EINVAL;
}
// Проход по байтам данных
for (i = 0; i < src_len; i++) {
// В первую очередь находит последовательность начальных флагов
if (state->start_index < 0) {
if (src[i] == HDLC_FLAG_SEQUENCE) {
// Проверяет, присутствует ли дополнительный байт последовательности флагов
if ((i < (src_len - 1)) && (src[i + 1] == HDLC_FLAG_SEQUENCE)) {
// Согласно протоколу HDLC, просто выполните цикл снова, чтобы молча отбросить его.
continue;
}
state->start_index = state->src_index;
}
} else {
// Проверка последовательность флага окончания
if (src[i] == HDLC_FLAG_SEQUENCE) {
// Проверка, присутствует ли дополнительный байт последовательности флага или был ли он получен ранее.
if (((i < (src_len - 1)) && (src[i + 1] == HDLC_FLAG_SEQUENCE))
|| ((state->start_index + 1) == state->src_index)) {
// Согласно протоколу HDLC, просто выполните цикл снова, чтобы молча отбросить его.
continue;
}
state->end_index = state->src_index;
break;
} else if (src[i] == HDLC_CONTROL_ESCAPE) {
state->control_escape = 1;
} else {
// Обновите значение на основе полученного символа управления экранирования (control escape)
if (state->control_escape) {
state->control_escape = 0;
value = src[i] ^ 0x20;
} else {
value = src[i];
}
// Теперь обновите значение FCS (контрольной суммы фрейма).
state->fcs = calc_fcs(state->fcs, value);
if (state->src_index == state->start_index + 2) {
// Поле управления (control field) находится вторым байтом после последовательности стартового флага.
*control = hdlc_get_control_type(value);
} else if (state->src_index > (state->start_index + 2)) {
// Начинает добавлять значения данных после поля управления (control field) в буфер.
dest[state->dest_index++] = value;
}
}
}
state->src_index++;
}
// Проверьте наличие неверного фрейма (отсутствие последовательности стартового или окончательного флага).
if ((state->start_index < 0) || (state->end_index < 0)) {
// Return no message and make sure destination length is 0
*dest_len = 0;
ret = -ENOMSG;
} else {
// Фрейм имеет размер не менее 4 байтов и содержит допустимое значение FCS (контрольной суммы).
if ((state->end_index < (state->start_index + 4))
|| (state->fcs != FCS_GOOD_VALUE)) {
// Возвращает ошибку FCS (контрольной суммы) и указывает, что данные до последовательности флага окончания в буфере должны быть отброшены.
*dest_len = i;
ret = -EIO;
} else {
// Возвращает успешный результат и указывает, что данные до последовательности флага окончания в буфере должны быть отброшены.
*dest_len = state->dest_index - sizeof(state->fcs);
ret = i;
}
// Сбрасывает значения для следующего фрейма
hdlc_get_data_reset_with_state(state);
}
return ret;
}
int hdlc_frame_data(hdlc_control_t *control, const char *src,
unsigned int src_len, char *dest, unsigned int *dest_len) {
unsigned int i;
int dest_index = 0;
unsigned char value = 0;
FCS_SIZE fcs = FCS_INIT_VALUE;
// Проверка, что все параметры валидны
if (!control || (!src && (src_len > 0)) || !dest || !dest_len) {
return -EINVAL;
}
// Добавления последовательности стартового флага.
dest[dest_index++] = HDLC_FLAG_SEQUENCE;
// Добавление адреса "все станции" из протокола HDLC (широковещательный адрес).
fcs = calc_fcs(fcs, HDLC_ALL_STATION_ADDR);
hdlc_escape_value(HDLC_ALL_STATION_ADDR, dest, &dest_index);
// Добавление значения поля управления фрейма.
value = hdlc_frame_control_type(control);
fcs = calc_fcs(fcs, value);
hdlc_escape_value(value, dest, &dest_index);
// Только фреймы типа DATA должны содержать данные.
if (control->frame == HDLC_FRAME_DATA) {
// Вычислите контрольную сумму FCS и экранируйте данные.
for (i = 0; i < src_len; i++) {
fcs = calc_fcs(fcs, src[i]);
hdlc_escape_value(src[i], dest, &dest_index);
}
}
// Инвертирует значения FCS в соответствии со спецификацией.
fcs ^= FCS_INVERT_MASK;
// Проходит по байтам FCS и выполните экранирование значений.
for (i = 0; i < sizeof(fcs); i++) {
value = ((fcs >> (8 * i)) & 0xFF);
hdlc_escape_value(value, dest, &dest_index);
}
// Добавляет последовательность флага окончания и обновляет длину фрейма.
dest[dest_index++] = HDLC_FLAG_SEQUENCE;
*dest_len = dest_index;
return 0;
}
int hello(){
return 1;
}

155
hdlc/hdlc.h
View File

@ -1,43 +1,128 @@
#ifndef DISPLAY_AVR_3_HDLC_H
#define DISPLAY_AVR_3_HDLC_H
/**
* @file hdlc.h
*/
#define HDLC_MRU 256
// HDLC constants --- RFC 1662
#define HDLC_FLAG_SOF 0x7e // Flag
#define HDLC_CONTROL_ESCAPE 0x7d // Control Escape octet
#define HDLC_ESCAPE_BIT 0x20 // Transparency modifier octet (XOR bit)
#define HDLC_CRC_INIT_VAL 0xffff
#define HDLC_CRC_MAGIC_VAL 0xf0b8
#define HDLC_CRC_POLYNOMIAL 0x8408
#define HDLC_UI_CMD 0x03 // Unnumbered Information with payload
#define HDLC_FINAL_FLAG 0x10 // F flag
#define HDLC_POLL_FLAG 0x10 // P flag
#ifndef HDLC_H
#define HDLC_H
typedef enum
{
HDLC_SOF_WAIT,
HDLC_DATARX,
HDLC_PROC_ESC,
#include "fcs.h"
#include <errno.h>
/** HDLC флаг начала и конца */
#define HDLC_FLAG_SEQUENCE 0x7E
/** HDLC управляющее выходное значение */
#define HDLC_CONTROL_ESCAPE 0x7D
/** HDLC все адресса станций */
#define HDLC_ALL_STATION_ADDR 0xFF
/** Поддерживаемые HDLC фрейм типы */
typedef enum {
HDLC_FRAME_DATA,
HDLC_FRAME_ACK,
HDLC_FRAME_NACK,
} hdlc_frame_t;
/** Информация о поле управления */
typedef struct {
hdlc_frame_t frame;
unsigned char seq_no :3;
} hdlc_control_t;
/** Перменные для hdlc_get_data и hdlc_get_data_with_state
* для отслеживания полученных буферов
*/
typedef struct {
char control_escape;
FCS_SIZE fcs;
int start_index;
int end_index;
int src_index;
int dest_index;
} hdlc_state_t;
typedef struct
{
uint8_t own_addr;
uint8_t src_addr;
uint8_t dest_addr;
uint8_t ctrl;
uint8_t *p_tx_frame; // tx frame buffer
uint8_t *p_rx_frame; // rx frame buffer
uint8_t *p_payload; // payload pointer
uint16_t rx_frame_index;
uint16_t rx_frame_fcs;
hdlc_state_t state;
} hdlc_t;
/**
* Установить состояние hdlc
*
* @param[in] state состояние hdlc, которое будет использоваться
* @retval 0 Успешно
* @retval -EINVAL Невалидный параметр
*/
int hdlc_set_state(hdlc_state_t *state);
/**
* Получить текущее состояние hdlc
*
* @param[out] state Текущее состояние hdlc
* @retval 0 Success
* @retval -EINVAL Невалидный параметр
*/
int hdlc_get_state(hdlc_state_t *state);
/**
* Извлекает данные из указанного буфера, содержащего HDLC-фрейм.
* Фреймы могут быть разобраны из нескольких буферов при получении через uart
*
* @param[out] control Структура поля управления с типом фрейма и номером последовательности.
* @param[in] src Основной буффер для фрейма
* @param[in] src_len Длинна основного буффера
* @param[out] dest Целевой буффер (должен быть способен содержать максимальный размер кадра)
* @param[out] dest_len Длинна целевого буффера
* @retval >=0 Успешно (размер возвращаемого значения должен быть удален из исходного буфера)
* @retval -EINVAL Невалидный параметр
* @retval -INMSG Невалидное сообщение
* @retval -EIO Невалидный FCS (размер dest_len должен быть удален из исходного буфера)
*
* @see hdlc_get_data_with_state
*/
int hdlc_get_data(hdlc_control_t *control, const char *src,
unsigned int src_len, char *dest, unsigned int *dest_len);
/**
* Извлекает данные из указанного буфера, содержащего HDLC-фрейм.
* Фреймы могут быть разобраны из нескольких буферов при получении через uart
*
* Эта функция вариация @ref hdlc_get_data
* Разница только в первом аргументе: hdlc_state_t *state
* Данные под этим указателем используются для отслеживания внутренних буферов.
*
* @see hdlc_get_data
*/
int hdlc_get_data_with_state(hdlc_state_t *state, hdlc_control_t *control, const char *src,
unsigned int src_len, char *dest, unsigned int *dest_len);
void hdlc_init(void);
/**
* Сбрасывает значения, используемые в функции hdlc_get_data для отслеживания полученных буферов
*/
void hdlc_get_data_reset();
void hdlc_process_rx_frame(uint8_t *buf, uint16_t len);
void hdlc_tx_frame(const uint8_t *txbuffer, uint8_t len);
/**
* Эта функция вариация @ref hdlc_get_data_reset
* Сбрасывает значения состояния, которые находятся под указателем, указанным в качестве аргумента
*
* Эта функция должна быть вызвана перед первым вызовом hdlc_get_data_with_state
* когда используется пользовательское хранилище состояний.
*
* @see hdlc_get_data_reset
*/
void hdlc_get_data_reset_with_state(hdlc_state_t *state);
#endif //DISPLAY_AVR_3_HDLC_H
/**
* Создает кадр HDLC с указанным буфером данных.
*
* @param[in] control Структура поля управления с типом кадра и порядковым номером
* @param[in] src Исходный буфер с данными
* @param[in] src_len Длинна исходного буффера
* @param[out] dest Целевой буфер (должно быть больше, чем исходный буфер)
* @param[out] dest_len Длинна целевого буффера
* @retval 0 Success
* @retval -EINVAL Невалидный параметр
*/
int hdlc_frame_data(hdlc_control_t *control, const char *src,
unsigned int src_len, char *dest, unsigned int *dest_len);
int hello();
#endif