/*************************************************************************************************************
  Copyright (C) 2016-2022 JSC "ICC Milandr" 

*************************************************************************************************************/

/*
 *
 *  Файл:      readme.txt
 *  Описание:  Описание примера ARINC_Transmit_Receive
 *
 *  История:
 *             29.09.22  - cоздан
 *
 */


/* Описание примера ----------------------------------------------------------------------------------------*/

В данном примере приведено, как настроить контроллер ARINC и выполнить с его помощью передачу массива данных. 

Настройка примера выполняется с помощью макроопределений, заданных в начале программы:
- наличие дефайна RX_EN включает в программу работу с приемником;
- наличие дефайна TE_EN включает в программу работу с передатчиком;
- наличие дефайнов CHECK_DATA и DATA_MAKE включает в программу проверку и создание случайных данных;
- значение дефайнов ARINC_RX и ARINC_TX определяет канал приемника/передатчика, который будет настраивается;
- дефайн NUM_OF_LABELS определяет количество корректных меток;
- дефайн DATA_SIZE определяет количество передаваемых/принимаемых данных. 
Обратите внимание, что в примере возможна передача данных объёмом, не превышающим размер буфера FIFO 
передатчика.

По умолчанию в примере выбрана работа с передатчиком 1 и с приемником 1. При объединении выводов передатчика и
приёмника можно протестировать работу примера без подключения внешних устройств. 

Если данные были переданы/получены успешно, то в отладочную консоль будет выведено сообщение "Result: Success". 
Если в ходе работы примера была зафиксирована ошибка, то в отладочную консоль будет выведено сообщение
"Result: Error - <Описание проблемы>".


/* Содержание каталога -------------------------------------------------------------------------------------*/

    - main.c               Основная программа
    - project.ldf          Файл сценария для компоновщика
    - session.lldbinit     Файл инициализации периферии до запуска отладки
    - .cproject, .project  Файлы конфигурации проекта


/* Аппаратная и программная среда --------------------------------------------------------------------------*/

    - Интегрированная среда разработки CM-LYNX.
    - Отладочная плата для процессора 1967ВН044.
	
	Для передачи данных с передатчика 1 на приемник 1 необходимо замкнуть следующие разъёмы на модуле отладочном:
	- XS1.1:7(PB4 - AR_IN1P) объединить с XS1.1:15(PB20 - AR_OU1P);
	- XS1.1:9(PB5 - AR_IN1N) объединить с XS1.1:17(PB21 - AR_OU1N).


/* Использование -------------------------------------------------------------------------------------------*/

Для запуска примера необходимо выполнить следующие действия:
    - Создать новое или открыть существующее рабочее пространство (Workspace).
    - Выполнить импорт проекта "ARINC_Transmit_Receive" в соответствии с 
      "ML_GUI_Руководство_пользователя_R_Vx", п. "Импорт существующего проекта".
    - Выполнить сборку проекта.
    - Создать конфигурацию отладки в соответствии с "ML_GUI_Руководство_пользователя_R_Vx", п. "Настройка 
      конфигурации и запуск отладки".
    - Запустить пример в режиме отладки.

Подробное описание библиотеки HAL с примерами использования функций приведено в каталоге по пути:
"CM-LYNX.x.yy.zz\toolchain\1967VN044\HAL\doc".
