42 lines
6.4 KiB
C
42 lines
6.4 KiB
C
#ifndef ZYNQ_NET_H /* Защищаем единый переносимый кодек Ethernet-обмена от повторного включения. */
|
||
#define ZYNQ_NET_H /* Один и тот же ABI используется ARM-службой и библиотекой настольного клиента. */
|
||
#include <stddef.h> /* Размеры пользовательских буферов передаются явно через size_t. */
|
||
#include <stdint.h> /* Фиксированные разрядности исключают различия ARMv7 и Windows x64. */
|
||
#if defined(_WIN32) /* Windows требует явного экспорта функций из отдельной библиотеки кодека. */
|
||
#define ZNET_API __declspec(dllexport) /* Экспортируем только функции, вызываемые тонким ctypes-портом. */
|
||
#else /* В ELF видимость по умолчанию подходит статической и динамической сборке. */
|
||
#define ZNET_API /* Кодек не зависит от конкретной ОС и сетевого стека. */
|
||
#endif /* Завершаем выбор атрибутов публичного ABI. */
|
||
#define ZNET_SIZE 64u /* Версия 1 передаёт ровно 64 байта UDP payload без зависимости от padding структур. */
|
||
#define ZNET_PORT 37570u /* Выделенный пользовательский UDP-порт проекта, одинаковый для поиска и обмена. */
|
||
#define ZNET_DISCOVER 1u /* Запрос сведений об устройстве допускает broadcast и не меняет состояние. */
|
||
#define ZNET_READ 2u /* Читаем два поля и восемь дискретов выбранной цели. */
|
||
#define ZNET_WRITE 3u /* Устанавливаем абсолютные значения: повтор пакета не переключает выходы заново. */
|
||
#define ZNET_WRITE_OUTPUTS 4u /* Записываем только DO, сохраняя счётчики A/B, которые независимо меняются кнопками платы. */
|
||
#define ZNET_REPLY 128u /* Старший бит операции отличает ответ от запроса, исключая отражение ответов. */
|
||
#define ZNET_ARM 0u /* Цель PS хранит учебные поля в памяти процесса Cortex-A9. */
|
||
#define ZNET_FPGA 1u /* Цель PL обслуживается только при явно подключённом UIO-модуле. */
|
||
#define ZNET_OK 0u /* Успешное выполнение позволяет применять полученные значения к интерфейсу. */
|
||
#define ZNET_UNAVAILABLE 1u /* Загруженный bitstream не предоставляет нужный модуль либо UIO не настроен. */
|
||
#define ZNET_BAD_REQUEST 2u /* Некорректные значения отклоняются до изменения ARM или AXI-регистров. */
|
||
#define ZNET_CAP_ARM 1u /* Бит capabilities подтверждает наличие учебного ARM-хранилища. */
|
||
#define ZNET_CAP_FPGA 2u /* Бит capabilities выставляется только после проверки аппаратных ID и ABI. */
|
||
#define ZNET_CAP_VIRTUAL_DI 4u /* Входы ARM являются программным эхом выходов, а не физическими контактами. */
|
||
#define ZNET_CAP_BOARD_IO 8u /* ARM управляет четырьмя штатными LED и читает четыре кнопки через драйверы Linux. */
|
||
#define ZNET_PL_ID 0x5a494f31u /* ASCII ZIO1 идентифицирует отдельный AXI-модуль простого обмена. */
|
||
#define ZNET_PL_VERSION 0x00010000u /* Старшая половина задаёт несовместимую версию аппаратной карты 1.0. */
|
||
typedef struct ZnetMessage { /* Host-представление никогда не отправляется в сеть прямым копированием. */
|
||
uint32_t operation, target, sequence, status; /* Операция, цель, номер запроса и код результата доступны через стабильный ABI. */
|
||
uint32_t field_a, field_b, inputs, outputs; /* Два беззнаковых 32-битных поля и младшие восемь бит входов/выходов. */
|
||
uint32_t capabilities, counter; /* Возможности и счётчик принятых корректных запросов облегчают диагностику. */
|
||
char name[24]; /* Имя устройства ограничено 23 ASCII-символами и завершающим нулём. */
|
||
} ZnetMessage; /* Размер структуры не определяет размер сетевого пакета: сериализация всегда явная. */
|
||
typedef struct ZnetArmState { /* Вызывающий владеет независимым состоянием каждого ARM-экземпляра. */
|
||
uint32_t field_a, field_b, outputs; /* Поля живут до перезапуска; Linux-порт при наличии BOARD_IO связывает младшие четыре DO со светодиодами. */
|
||
} ZnetArmState; /* Переносимое хранилище не использует heap и глобальные переменные. */
|
||
ZNET_API int znet_encode(uint8_t *wire, size_t capacity, const ZnetMessage *message); /* Проверяем поля и записываем ровно один пакет в буфер вызывающего. */
|
||
ZNET_API int znet_decode(ZnetMessage *message, const uint8_t *wire, size_t length); /* Отвергаем чужие magic/version/размеры до обращения к состоянию. */
|
||
ZNET_API uint32_t znet_arm_apply(ZnetArmState *state, const ZnetMessage *request, ZnetMessage *reply); /* Общая логика ARM READ/WRITE тестируется независимо от Linux-сокетов. */
|
||
ZNET_API void znet_arm_key(ZnetArmState *state, uint32_t *held, unsigned key, int value); /* Обрабатываем фронт кнопки 0:A+, 1:A−, 2:B+, 3:B−; evdev repeat=2 не меняет счётчик. */
|
||
#endif /* Завершаем публичный контракт версии 1. */
|