Описание библиотеки для стенда
Описание файла
Документ из архива "Описание библиотеки для стенда", который расположен в категории "". Всё это находится в предмете "программное обеспечение управляющих комплексов (поук)" из 9 семестр (1 семестр магистратуры), которые можно найти в файловом архиве МГТУ им. Н.Э.Баумана. Не смотря на прямую связь этого архива с МГТУ им. Н.Э.Баумана, его также можно найти и в других разделах. Архив можно найти в разделе "книги и методические указания", в предмете "поук" в общих файлах.
Онлайн просмотр документа "Описание библиотеки для стенда"
Текст из документа "Описание библиотеки для стенда"
Московский государственный технический университет им. Н.Э. Баумана
Факультет «Робототехника и комплексная автоматизация»
Кафедра «Робототехника»
Драйвер USB многофункционального
устройства URC220 для ОСРВ QNX
Пояснительная записка
Студент ……………………… (Куренев П.Н.) Группа РК10-72
Руководитель проекта ……………………… (Гончаренко К.В.)
Москва
2007
1. Техническое задание
Необходимо разработать для операционной системы реального времени QNX драйвер устройства URC220, подключаемого к компьютеру через универсальную последовательную шину (USB).
Также необходимо разработать библиотеку для облегчения написания пользовательских программ на C++, а также описание этой библиотеки и демонстрационные программы.
2. Драйвер
Для многих задач не всегда требуется писать программу непосредственно для микроконтроллера, так как достаточно простого управления с компьютера. Для этого была реализована программа для микроконтроллера, которая принимает команды от компьютера по USB интерфейсу и управляет всеми периферийными устройствами на плате. Для компьютера создан драйвер и библиотека, которая позволяет легко управлять платой из любой программы под QNX.
Драйвер USB устройства URC220 реализован в виде исполняемого файла “URCSrv”. Кроме драйвера, программа также является нумератором подключаемых устройств. Выполнена в виде консольного приложения.
Программа URCSrv, выполняет следующие задачи:
- определение факта подключения устройства;
- назначение номера подключённому устройству;
- обработка подключения, установление соединения;
- корректное отключение от устройства;
- предоставление интерфейса для взаимодействия с устройствами пользовательским программам.
2.1 Алгоритм работы
После за пуска, драйвер подключается к USB стеку QNX и назначает функции, которые операционная система вызывает в случае подключения и отключения устройства.
Функция также создаёт объект общего доступа к памяти под именем “/dev/shmem/urc_srv_100”. С помощью этого объекта происходит взаимодействие между драйвером и пользовательскими программами.
После подключения устройства, программа ищет незанятый номер в диапазоне [0; (URC_MAXDEV-1)] (URC_MAXDEV = 127) и присваивает его вновь подключённому устройству. Все дальнейшие обращения к устройству будут производиться по этому номеру (номер является индексом элемента в массиве объектов структур-описателей).
Далее происходит подключение к устройству и считывание его дескрипторов (дескриптор устройства, конфигурации, конечных точек (endpoints)) и проверка их соответствия тем, которые должны быть у устройств, для которых написан этот драйвер. Это вторая проверка, так как ещё при подключении к USB стеку были заданы VID (Vendor ID) и PID (Product ID) того устройства, подключение которого нужно обрабатывать.
Затем создаются потоки чтения и записи (pipes) и выделяется память для буфера данных. Теперь устройство готово к работе, поэтому создаётся поток (thread) для обработки команд пользовательского приложения. То есть, кроме основного потока программы создаётся ещё по одному потоку на каждое подключённое устройство.
Рис.1.1 Внешний вид программы URCSrv |
Общая память представляет собой массив из URC_MAXDEV элементов. Каждый элемент массива – структура. Поля структуры составляют:
- mutex для распределения доступа к памяти между драйвером и приложениями;
- состояние этого слота подключения;
- данные, отправляемые или принимаемые из устройства;
- команда; которую должен выполнить сервер.
После отключения устройства происходит удаление всех созданных объектов (mutex, pipes, буфер и т.д.) и отсоединение от устройства.
При закрытии программы происходит принудительное отключение от всех подключённых устройств, а также удаление объекта общего доступа к памяти.
Все действия драйвера отображаются в окне программы (см. рис.1.1).
3. Библиотека для работы с платой на компьютере
Библиотека представляет собой класс CURC220, который упрощает взаимодействие между пользовательской программой и драйвером, то есть с объектом общего доступа к памяти, который создаёт драйвер.
Библиотека автоматически производит адресацию к общей памяти, после чего через оболочку в виде класса CURC220 предоставляет программе доступ к этой памяти.
3.1 Алгоритм работы с библиотекой
Вся работа с библиотекой происходит через объект класса CURC220. Прототип класса находится в заголовочном файле “urc220.h”:
#include “urc220.h”
CURC220 urc;
Сначала необходимо определить, устройства с какими номерами подключены к компьютеру. Для этого используется функция GetDevStates() класса, которая возвращает состояние всех слотов для подключения устройств. Перебрав в цикле значения всех ячеек, можно определить номера подключённых плат, так как номера ячеек, значение которых равно URCSTATE_OPENED, являются номерами подключённых плат.
Для начала работы с платой нужно открыть устройство функцией Open(), а по окончании работы вызвать функцию Close(). Если устройство успешно открыто, то записывать и считывать данные можно при помощи функций Read() и Write(). Сначала вызывается функция для чтения (Read), далее производятся необходимые действия (функции GetInput, SetOutput, GetOutput, GetADC и т.д.), а по окончании всех действий вызывается функция для записи (Write). Затем цикл повторяется.
3.2 Описание функций класса CURC220
Функция GetDevStates
Прототип:
int CURC220::GetDevStates(uint32 states[URC_MAXDEV]);
Описание:
Функция записывает в массив states состояние всех слотов для подключения устройств. Элементы массива могут принимать следующие значения:
- URCSTATE_CLOSED – устройство с номером, соответствующем номеру элемента массива, не подключено
- URCSTATE_OPENED – устройство подключено
Принимаемые параметры:
states – массив чисел из URC_MAXDEV элементов
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция Close
Прототип:
void CURC220::Close();
Описание:
Функция закрывает устройство
Принимаемые параметры: нет
Возвращаемое значение: нет
Функция Open
Прототип:
int CURC220::Open(uint32 index);
Описание:
Функция открывает устройство
Принимаемые параметры:
index - номер устройства (начиная с 0)
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция Read
Прототип:
int CURC220::Read();
Описание:
Считывает текущее состояние устройства
Принимаемые параметры: нет
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция Write
Прототип:
int CURC220::Write();
Описание:
Записывает внесенные изменения параметров в устройство
Принимаемые параметры: нет
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция GetInput
Прототип:
int CURC220::GetInput(uint32 index, uint8 *value);
Описание:
Считывает значение на порту ввода
Принимаемые параметры:
index - номер порта: 0..3
value - указатель на число для записи значения: 0 или !0
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция SetOutput
Прототип:
int CURC220::SetOutput(uint32 index, uint8 value);
Описание:
Записывает значение в порт вывода
Принимаемые параметры:
index - номер порта: 0..7
value - число для записи в порт: 0 или !0
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция GetOutput
Прототип:
int CURC220::GetOutput(uint32 index, uint8 *value);
Описание:
Возвращает значение, которое сейчас установлено на порту вывода
Принимаемые параметры:
index - номер порта: 0..7
value - указатель на число для записи значения: 0 или !0
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция GetADC
Прототип:
int CURC220::GetADC(uint32 channel, uint16 *value);
Описание:
Считывает значение АЦП
Принимаемые параметры:
channel - номер канала: 0..3
value - указатель на число для записи значения: 0..1023
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция SetPWM
Прототип:
int CURC220::SetPWM(uint32 channel, int16 value);
Описание:
Устанавливает значение ШИМ
Принимаемые параметры:
channel - номер канала: 0..3
value - новое значение ШИМ: -1000...+1000
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция GetPWM
Прототип:
int CURC220::GetPWM(uint32 channel, int16 *value);
Описание:
Возвращает установленое значение ШИМ
Принимаемые параметры:
channel - номер канала: 0..3
value - указатель на число для записи значения: -1000...+1000
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
Функция GetEnc
Прототип:
int CURC220::GetEnc(uint32 index, int32 *value);
Описание:
Считывает значение энкодеров
Принимаемые параметры:
index - номер энкодера: 0..1
value - указатель на число для записи значения
Возвращаемое значение:
Функция возвращает 0 в случае ошибки
4. Применение библиотеки
4.1 Создание проекта
Сначала загрузите QNX Momentics IDE (“Launch” – “QNX Momentics Development Suite 6.3.2” – “Integrated Development Environment”).
Если вы загружаете эту среду первый раз, то вам будет предложено выбрать папку для хранения проектов. Если оставить ту, что стоит по умолчанию, то workspace (пространство для хранения объектов) будет создано в папке “/user_name/ide4-workspace/” (user_name – имя пользователя). Все вновь создаваемые проекты будут добавляться в этот workspace.
Рис.4.1 Настройки нового проекта |
После загрузки среды выберете меню “File” – “New” – “Project”. В появившемся окне выберете тип проекта: “C++” – “QNX C++ Project” и нажмите на “Next”. Затем введите имя проекта (“Project Name”), например "test_simple”, а также вид конечного файла (“Type”) - “Application” (приложение).
Далее нажмите на “Next”. В следующем окне выберете вкладку “Build Variants”, где установите пункты “X86 (Little Endian)” (см. рис.4.1).
Новый проект создастся после нажатия на “Finish” в папке “/User_name/de4-workspace/test_simple”.
В проекте появится файл исходного кода “test_simple.cc” с минимальным кодом для компиляции.
4.2 Пример использования
Рассмотрим простой пример, который продемонстрирует запись данных в устройство. Для начала нужно переписать в папку с проектом файлы библиотеки: “stdtypes.h”, “urc220.h”. Все файлы в каталоге с проектом автоматически добавляются в проект. Чтобы увидеть их в списке, нажмите на название проекта правой кнопкой мыши и выберете пункт меню “Refresh”.
Изменим исходный код. Добавим необходимые заголовочные файлы (в том числе файл библиотеки). Также прототип функции select_device(), которая понадобится в дальнейшем, а также создадим объект класса CURC220, с помощью которого и будем работать с устройством.
//------------------------------------------------------------