Diferencia entre revisiones de «Usb4all»
(→Arquitectura) |
(→5. Entorno de desarrollo) |
||
(No se muestran 225 ediciones intermedias de 6 usuarios) | |||
Línea 1: | Línea 1: | ||
− | == Motivación == | + | == 1. Motivación == |
La motivación de este proyecto se centra en lograr de una manera sencilla, la comunicación entre un sistema computador y un conjunto de dispositivos electrónicos no necesariamente pensados para interactuar con una computadora. | La motivación de este proyecto se centra en lograr de una manera sencilla, la comunicación entre un sistema computador y un conjunto de dispositivos electrónicos no necesariamente pensados para interactuar con una computadora. | ||
− | Durante muchos años la única forma de interactuar con dispositivos externos desde a un computador personal (Personal Computer) (PC) fueron los puertos seriales y paralelos, esto llevo a que se utilizaran ampliamente en multiplicidad de dispositivos. Sus principales | + | Durante muchos años la única forma de interactuar con dispositivos externos desde a un computador personal (Personal Computer) (PC) fueron los puertos seriales y paralelos, esto llevo a que se utilizaran ampliamente en multiplicidad de dispositivos. Sus principales características son su simplicidad de manejo vía software y facilidad de inclusión en distintos dispositivos. En la última década han aparecido nuevos medios o canales de comunicación, tales como Bluetooth, Fidelidad Inalámbrica (Wireless Fidelity) (WiFi), FireWire, Bus Universal en Serie (Universal Serial Bus) (USB), etc. Estos permitieron mejorar las velocidades de comunicación y calidad de datos y lentamente tornaron a los puertos paralelos y seriales en obsoletos, hasta llegar al día de hoy en que se obtienen sólo de manera opcional en los nuevos PC. |
Dentro de todas estas nuevas tecnologías que aparecieron la que tuvo mayor aceptación y difusión entre los usuarios fue el USB, debido a su facilidad y versatilidad de escenarios de uso. Esta simplicidad desde el punto de vista del usuario de los dispositivos USB tiene como contrapartida una mayor complejidad para los desarrolladores de software y hardware, lo cual es un gran problema al momento de interactuar con dispositivos electrónicos. | Dentro de todas estas nuevas tecnologías que aparecieron la que tuvo mayor aceptación y difusión entre los usuarios fue el USB, debido a su facilidad y versatilidad de escenarios de uso. Esta simplicidad desde el punto de vista del usuario de los dispositivos USB tiene como contrapartida una mayor complejidad para los desarrolladores de software y hardware, lo cual es un gran problema al momento de interactuar con dispositivos electrónicos. | ||
Frente a estas adversidades que presenta el entorno actual aparece la necesidad de buscar una forma de reducir el grado de complejidad y conocimientos necesarios para poder desarrollar | Frente a estas adversidades que presenta el entorno actual aparece la necesidad de buscar una forma de reducir el grado de complejidad y conocimientos necesarios para poder desarrollar | ||
Línea 9: | Línea 9: | ||
En el contexto de lo antedicho aparecen un conjunto de desafíos como son el desarrollo de controladores (drivers) y construcción de piezas de hardware que brinde una solución genérica | En el contexto de lo antedicho aparecen un conjunto de desafíos como son el desarrollo de controladores (drivers) y construcción de piezas de hardware que brinde una solución genérica | ||
reutilizable, desplazando el manejo de los casos particulares a componentes específicos. Esto proporciona el beneficio de evitar que cada vez que se necesite conectar un nuevo dispositivo, | reutilizable, desplazando el manejo de los casos particulares a componentes específicos. Esto proporciona el beneficio de evitar que cada vez que se necesite conectar un nuevo dispositivo, | ||
− | se comience desde cero. A su vez permite recuperar y potenciar la característica de facilidad de manejo que poseían los puertos seriales y paralelos, explotando todas las capacidades brindadas | + | se comience desde cero. A su vez permite recuperar y potenciar la característica de facilidad de manejo que poseían los puertos seriales y paralelos, explotando todas las capacidades brindadas por USB. |
− | por USB. | + | |
− | == Arquitectura == | + | == 2. Arquitectura (Firmware/Hardware)== |
− | La arquitectura | + | La arquitectura está compuesta por diferentes componentes, los cuales van a permitir el funcionamiento del sistema desde lo relativo al hardware como las abstracciones necesarias para manejarlo mediante software.<br> |
+ | Los componentes principales son: | ||
− | '''USB4all ''Baseboard''''' | + | '''2.1 USB4all ''Baseboard''''' |
− | + | ||
− | + | ||
− | + | ||
+ | [[Archivo:usb4all2.png|thumb|Fig.2.1.1: USB4all Baseboard 2.0]] | ||
+ | Es una placa de entrada/salida(E/S) configurable que se conecta por USB con un sistema computador. El proyecto USB4all es mucho más que una placa de E/S, en sí es una forma de modelar sistemas embebidos, siendo la placa de E/S un componente que fue necesario construir para desarrollar la solución completa. Para la construcción de esta placa se utilizó un microcontrolador PIC18F4550 de Microchip. Entre las características más destacadas en lo que concierne al proyecto se encuentra el soporte completo del estándar USB, pudiéndose utilizar varias de sus características, como ser diferentes tipos de transferencias y varios canales de comunicación (endpoints). El diseño de hardware de la placa puede descargarse del [http://sourceforge.net/p/usb4all/code/ci/6ecc2581f50519fe427f7a3947136c2a03108841/tree/pcb/ git del proyecto] permitiendo que cualquiera pueda armarse una USB4all ''baseboard'' utilizando el software GPL [http://www.lis.inpg.fr/realise_au_lis/kicad/ Kicad]. | ||
− | '''USB4all ''base firmware''''' | + | '''2.2 USB4all ''base firmware''''' |
− | + | ||
+ | Es el firmware más estático, brinda servicios a los usermodules para que puedan utilizar los recursos presentes en la baseboard (timmers, puerto USB, conversores A/D, etc) además de brindar las primitivas para el intercambio de mensajes entre el computador y el usermodule y realiza la gestión de los ''usermodules''. Establece las bases para que los usermodules sean independientes del protocolo de comunicación computador/placa y de los detalles de hardware del microcontrolador utilizado. A su vez oferce un entorno de ejecución concurrente que permite instanciar de forma dinámica varios ''usermodules''. | ||
+ | |||
+ | '''2.3 USB4all ''usermodule''''' | ||
+ | |||
+ | Son los componentes intercambiables del sistema que permiten encapsular la lógica de un dispositivo especifico y su protocolo de comunicación con las aplicaciones de usuario. Permite al usuario dar rápidamente soporte a un nuevo dispositivo de forma genérica, expandiendo de esta manera las funcionalidades del USB4all ''basefirmware''. Los ''user modules'' son los bloques principales sobre los que se construye la arquitectura USB4all. Exponen una API uniforme que es utilizada a modo de callbacks por el ''base firmware'' y también exponen los servicios que brindan los dispositivos. Es recomendable modelar cada uno de los dispositivos electrónicos conectados a la ''baseboard'' como un ''usermodule'' donde los servicios a exponer se mapean con las características del mismo, como ejemplo en el caso de un motor, sería esperable que expusiera servicios para moverse, cambiar la velocidad y el sentido. | ||
+ | |||
+ | Del lado del sistema computador se dispone de diferentes formas de interacción: Todas ellas implementan el protocolo USB4all, su objetivo es abstraer al usuario del mismo brindando una forma sencilla de utilizar el sistema, existiendo soporte para diferentes lenguajes de programación. El objetivo principal de las bibliotecas utilizadas en el computador son las de permitir utilizar los servicios de los ''usermodules''. Esta forma de trabajo permite desarrollar la lógica de interacción entre los diferentes dispositivos electrónicos dentro del sistema computador, con lenguajes de mayor abstracción, mejores herramientas de desarrollo, permitiendo generar un código con un nivel de mantenibilidad y abstracción mayor al que se lograría si todo estuviera embebido en el microcontrolador. | ||
+ | |||
+ | Uno de los componentes más usados actualmente es el [[bobot]] que persigue un enfoque genérico al igual que el proyecto USB4all y permite acompañar la extensibilidad de la placa USB4all mediante el uso de ciertos componentes propios de la arquitectura llamados drivers. | ||
+ | |||
+ | == 3. Protocolo de Comunicación == | ||
+ | |||
+ | El protocolo está formado por un stack de protocolos que permiten abstraer al usuario de los detalles subyacentes de la arquitectura. | ||
+ | El objetivo final del protocolo de comunicación, es direccionar los mensajes provenientes desde la aplicación que se ejecuta en el computador, al ''usermodule'' correspondiente ejecutado en la placa USB4all. | ||
+ | Estos mensajes son solicitudes de ciertos servicios que los módulos exponen, por ejemplo en el caso de un dispositivo sonoro (buzzer) utilizado para una alarma, va a ser de interés poder emitir sonido (Prender el Buzzer) detener la emisión de sonido (Apagar el Buzzer), hacer sonidos cortos pasando por parámetro la cantidad de milisegundos que se desea esté prendido, etc. | ||
+ | Estos mensajes se tienen que codificar de alguna manera, el protocolo especifica que primero se debe indicar el comando que se desea se ejecute y luego en caso que sea necesario (como en el de los sonidos cortos) enviar los parámetros. En algunos casos va a ser necesario obtener respuestas, las cuales se codifican de forma análoga usando el mismo protocolo, enviando en lugar de un parámetro un valor de retorno. | ||
+ | Este protocolo es llamado ''user protocol'' y está enfocado al usuario final, pero para que el sistema funcione correctamente es necesario contar con otros protocolos los cuales transportan el protocolo ''user protocol''. Tal es el caso del handler manager protocol que se encarga de manejar el ruteo de los mensajes al ''user module'' correspondiente. Esto se debe a que en un momento determinado puede haber varios ''user modules'' ejecutando en la placa y el sistema debe permitir notificar del nuevo mensaje al módulo para el cual está destinado el mismo. La tarea fundamental de este protocolo es brindar los mecanismos para comunicar una aplicación con un ''user module''. Otro protocolo involucrado es el ''admin protocol'' el cual se encarga de gestionar el ciclo de vida de los ''user modules'', permitiendo poner a ejecutar un ''user module'', cerrarlo y también algunas funcionalidades como el listar los módulos presentes en la placa, cerrar todos los modulos abiertos o llevar al estado de reset al microcontrolador. Tanto el ''handler protocol'' como el ''admin protocol'' son implementados por las bibliotecas que se utilicen en el computador. Existiendo varias opciones, Java, Python o Lua. Actualmente la opción que se está manteniendo es la de Lua, la cual puede estudiarse en profundidad en la sección [[bobot]]. | ||
+ | |||
+ | [[Archivo:protocolo.png|700px|Fig. 3.2 Protocolo USB4all]] | ||
+ | |||
+ | Finalmente los paquetes USB4all se trasmiten por el protocolo de comunicación que disponga el ''baseboard'', para el caso típico del ''baseboard usb4all'' se trasmite mediante USB, pero puede ser trasmitido mediante otras tecnologías utilizadas para comunicarse con un computador, como ser serial o bluetooth (entre otros). | ||
+ | |||
+ | == 4. Grabando el Firmware == | ||
+ | [[Archivo:usb4all2_top_view.png|thumb|Fig.4.1: USB4all Baseboard 2.0 vista desde arriba]] | ||
+ | Para grabar el firmware se necesita disponer de un programador hardware, como el picdem o el pickit, este último tiene buen soporte dentro de GNU/Linux. | ||
+ | Microchip distribuye un bootloader para la familia de microcontroladores 18F. Un bootloader es un programa que se utiliza para grabar y/o actualizar el firmware. En nuestro caso, va a permitr grabar el firmware del proyecto USB4all sin la necesidad de disponer de un programador por hardware, para realizar esto es necesario dejar presionado el botón de programación como puede verse en la figura 4.1 mientras se resetea la placa con el botón de reset. Esto funciona siempre y cuando el microcontrolador tenga grabado el bootloader. | ||
+ | Una vez que el dispositivo se encuentra en modo programación su identificador de producto cambia de 000c a 000b, esto puede verificarse utilizando el comando ''lsusb'' cuya salida se adjunta para los dos casos a continuación: | ||
+ | |||
+ | Id dispositivo USB4all | ||
+ | Bus 002 Device 002: ID 04d8:000c Microchip Technology, Inc. | ||
+ | |||
+ | id dispositivo Bootloader | ||
+ | Bus 002 Device 003: ID 04d8:000b Microchip Technology, Inc. | ||
+ | |||
+ | Dado que Microchip no distribuye microcontroladores con el bootlader previamente grabado, es necesario utilizar un programador por hardware para grabar el bootloader. | ||
+ | USB4all actualmente utiliza un bootloader modificado que permite actualizar el firmware programáticamente sin necesidad de presionar los botones, útil a la hora de realizar actualizaciones remotas, pero responde a los mismos comandos que el bootloader de Microchip, lo cual permite reutilizar el software ya desarrollado para interactuar con el bootloader. | ||
+ | Los fuentes del bootloader pueden encontrarse en el repositorio en el directorio bootloader del firmware, es un proyecto separado y una vez compilado su grabación se realiza mediante un programador por hardware como picdem o pickit. | ||
+ | Una vez grabado el bootloader ya '''no es necesario utilizar programadores por hardware''' y puede realizarse la grabación del firmware mediante varios programas que implementan el protocolo de grabación de firmware de microchip. Una de esas utilidades es el programa fsusb el cual puede encontrarse en [http://www.internetking.org/fsusb/] y es de código libre. Su uso se realiza de la siguiente forma: | ||
+ | |||
+ | ./fsusb --program usb4all2.hex | ||
+ | |||
+ | Donde usb4all2.hex es el binario generado como resultado de compilar el proyecto. Recordar que el hardware debe estar en modo bootloader para poder recibir el firmware. | ||
+ | |||
+ | ==== 4.1 Grabando Bootloader + Firmware ==== | ||
+ | Una manera rápida, luego que se tiene acceso a un programador, es grabar el bootloader correspondiente y algún firmware (todo junto). | ||
+ | Para eso pueden usar este .hex: | ||
+ | |||
+ | [http://www.fing.edu.uy/inco/proyectos/butia/files/firmware/bootloader_con_admin.hex bootloader_con_admin.hex] | ||
+ | |||
+ | |||
+ | '''Nota.''' Ahora es posible grabar el firmware fácilmente mediante la siguiente actividad [[Grabar Firmware|Grabar Firmware]]. | ||
+ | |||
+ | == 5. Entorno de desarrollo == | ||
+ | [[Archivo:piklab.png|thumb|Fig. 5.1:Entorno de desarrollor con Piklab en GNU/Linux]][[Archivo:mplab.png|thumb|Fig. 5.2: Entorno de desarrollo con MPLab en GNU/Linux]] | ||
+ | El proyecto USB4all está desarrollado para el compilador C18 de Microchip, hoy día se dispone de un buen soporte del mismo para GNU/Linux pudiéndose descargar de [http://www.fing.edu.uy/inco/proyectos/butia/files/IDE/] también se dispone de un entorno de desarrollo llamado MPLab el cual también se encuentra disponible para GNU/Linux en la misma dirección. | ||
+ | Hace un tiempo atrás no existía compatibilidad para GNU/Linux de estas herramientas clásicas para los ambientes Windows en GNU/Linux. Debiéndose recurrir a alternativas para trabajar en un ambiente GNU/Linux, una opción era Piklab. Piklab es un entorno de desarrollo para trabajar con microcontroladores PIC similar a lo que es MPLab. Era muy común utilizar la versión de C18 de Windows emulada mediante wine en GNU/Linux debiéndose configurar en las opciones de toolchain de PIKLab correspondientes a C18 para que apunten correctamente a los directorios donde se encuentra el compilador C18. En el repositorio puede encontrarse un proyecto piklab configurado de esta manera. Más información sobre la configuración de c18 con piklab en linux (deprecated) ver: [http://cantareus.com/2009/08/18f4550-and-18f2550-with-piklab-and-ubuntu/] | ||
+ | <br>Luego de compilar, cargar el binario generado (.hex) en la placa mediante el uso del bootloader que se incluye en el firmware. Esto puede realizarse utilizando la herramienta fsusb como se describe en la sección Grabando el Firmware. | ||
+ | |||
+ | '''Nota.''' Para sistemas de 64 bits se debe tener instalada la librería ia32-libs. | ||
+ | |||
+ | == 6. Escribiendo un ''usermodule'' == | ||
+ | Un ''usermodule'' es el bloque sobre el cual se representa una realidad y se modela utilizando la arquitectura ''USB4all'', en esta sección se presentan sus características, estructura necesaria para especificar los servicios que brinda y de que forma se anexa al ''basefirmware'' | ||
+ | |||
+ | [[Archivo:user_module.png|thumb|Fig. 6.1: Tabla de referencias a ''user modules'']] | ||
+ | |||
+ | '''6.1 Estructura de un ''usermodule:'' '''<br> | ||
+ | Un ''usermodule'' debe cumplir con una API determinada, de esta manera es posible agregar las funcionalidades que el módulo expone, dentro del ''basefirmware''. | ||
+ | Las operaciones principales que se deben implementar son las encargadas de atender los eventos de: | ||
+ | * inicialización | ||
+ | * liberación de recursos | ||
+ | * configuración | ||
+ | |||
+ | Estas operaciones se ejecutan en determinados momentos del ciclo de vida de una aplicación USB4all, siendo la operación registrada al evento de inicialización invocada al abrir desde la aplicación el ''usermodule'' y la de liberación de recursos al cerrarlo, esto permite utilizar los recursos del microcontrolador solo cuando es necesario. La operación de configuración puede invocarse en cualquier momento para cambiar en caliente algún aspecto de configuración del hardware. | ||
+ | Al comenzar un ''usermodule'' se debe declarar cuales van a ser las funciones que van a atender estos eventos y el nombre del módulo para ser identificado desde el computador al listar los módulos presentes en la placa. | ||
+ | |||
+ | #pragma romdata user | ||
+ | uTab userBuzzerModuleTable = {&UserBuzzerInit,&UserBuzzerRelease,&UserBuzzerConfigure,"buzzer"}; | ||
+ | #pragma code | ||
+ | |||
+ | Donde user es el nombre de la sección y uTab es una estructura para almacenar las posiciones de memoria de las operaciones que exporta el módulo y su nombre. En la sección detalles de implementación en el firmware se puede conocer más sobre el significado de la instrucción #pragma romdata user, podemos por el momento asumir que sirve para almacenar la estructura uTab en un lugar conocido dentro de la memoria de programa. | ||
+ | |||
+ | El ''basefirmware'' se encarga de pasar como argumento a la operación init el número de handler asignado al módulo, este número es utilizado como argumento en otras operaciones como ser ''setHandlerReceiveFunction'' la cual recibe por parámetro el handler y un puntero a la función encargada de manejar la recepción de datos. | ||
+ | Otra operación que necesita el ''handlerID'' es ''getSharedBuffer'' la cual recibe por parámetro el ''handlerID'' del módulo y retorna un buffer por el cual el módulo puede enviar datos a la aplicación que ejecuta en el computador. | ||
+ | Un buen lugar para obtener este buffer y registrar la función de recepción de datos es la operación encargada del evento de inicialización. A continuación puede verse como ejemplo la inicialización de un módulo de usuario para controlar un buzzer: | ||
+ | |||
+ | <syntaxhighlight lang="C"> void UserBuzzerInit(byte i) { | ||
+ | usrBuzzerHandler = i; | ||
+ | // add my receive function to the handler module, to be called automatically when the pc sends data to the user module | ||
+ | setHandlerReceiveFunction(usrBuzzerHandler,&UserBuzzerReceived); | ||
+ | // initialize the send buffer, used to send data to the PC | ||
+ | sendBufferUsrBuzzer = getSharedBuffer(usrBuzzerHandler); | ||
+ | }//end UserBuzzerInit </syntaxhighlight> | ||
+ | |||
+ | La función de recepción de datos es la encargada de implementar el protocolo de comunicación entre el ''usermodule'' y la aplicación, típicamente es una estructura tipo ''case'' en el que se espera por los diferentes comandos que pueden enviarse. La forma de codificar el pedido de servicios es mediante mensajes del tipo < COMANDO [argumento1] [argumento2]...[argumentoN] >. La respuesta debe ser del tipo < COMANDO [resultado1] [resultado2]..[resultadoN] >. El buffer para enviar datos al computador es obtenido como argumento de la función y el buffer para enviar datos fue obtenido previamente en la función de inicialización. | ||
+ | |||
+ | <syntaxhighlight lang="C"> void UserBuzzerReceived(byte* recBuffPtr, byte len){ | ||
+ | byte index; | ||
+ | byte j; | ||
+ | byte userBuzzerCounter = 0; | ||
+ | byte tiempo; | ||
+ | |||
+ | switch(((BUZZER_DATA_PACKET*)recBuffPtr)->CMD){ | ||
+ | case READ_VERSION: | ||
+ | //dataPacket._byte[1] is len | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0]; | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1]; | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[2] = BUZZER_MINOR_VERSION; | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[3] = BUZZER_MAJOR_VERSION; | ||
+ | userBuzzerCounter = 0x04; | ||
+ | break; | ||
+ | |||
+ | case PRENDER: | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0]; | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1]; | ||
+ | buzzer_on(); | ||
+ | userBuzzerCounter = 0x02; | ||
+ | break; | ||
+ | |||
+ | case APAGAR: | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0]; | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1]; | ||
+ | buzzer_off(); | ||
+ | userBuzzerCounter = 0x02; | ||
+ | break; | ||
+ | |||
+ | case BUZZER_TRIPLE: | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0]; | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1]; | ||
+ | cantTicks1 = (byte)(((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1]); | ||
+ | cantTicks2 = (byte)(((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[2]); | ||
+ | cantTicks3 = (byte)(((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[3]); | ||
+ | boubleBeep(cantTicks1, cantTicks2, cantTicks3); | ||
+ | userBuzzerCounter = 0x02; | ||
+ | break; | ||
+ | |||
+ | case BUZZER_CORTO: | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0]; | ||
+ | ((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1]; | ||
+ | cantTicks3 = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1]; | ||
+ | timeOutTicksBuzz = 1; // lo seteo timmer para que venza inmediantamente | ||
+ | buzzerState = DELAY; | ||
+ | registerT0event(0, &buzzEvent); | ||
+ | userBuzzerCounter = 0x02; | ||
+ | break; | ||
+ | |||
+ | case RESET: | ||
+ | Reset(); | ||
+ | break; | ||
+ | |||
+ | default: | ||
+ | break; | ||
+ | }//end switch(s) | ||
+ | if(userBuzzerCounter != 0){ | ||
+ | j = 255; | ||
+ | while(mUSBGenTxIsBusy() && j-->0); // pruebo un máximo de 255 veces | ||
+ | if(!mUSBGenTxIsBusy()) | ||
+ | USBGenWrite2(usrBuzzerHandler, userBuzzerCounter); | ||
+ | }//end if | ||
+ | }//end UserBuzzerReceived</syntaxhighlight> | ||
+ | |||
+ | En este ejemplo se puede apreciar como se reciben los pedidos de comandos desde la aplicación que ejecuta en el computador y como se obtienen los parámetros necesarios para implementar los comandos y se devuelven los datos (en caso de ser requeridos) a la aplicación. | ||
+ | |||
+ | '''6.2 Entrada/Salida en user modules:'''<br> | ||
+ | Una de las tareas más importantes de los ''usermodules'' es la de realizar entrada/salida con diferentes periféricos electrónicos. Para realizar esta tarea existen dos paradigmas: | ||
+ | <br> | ||
+ | * Polling | ||
+ | * Interrupciones | ||
+ | <br> | ||
+ | Dentro de la arquitectura USB4all existen formas de que los módulos implementen entrada/salida utilizando estos paradigmas, para el caso de pooling existe un servicio que permite registrar una función para ser ejecutada cuando el procesador esté disponible. | ||
+ | |||
+ | <syntaxhighlight lang="C"> | ||
+ | addPollingFunction(&UserBuzzerProcessIO); | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | Existe soporte para interrupciones mediante el módulo ''DynamicISR'' el cual permite que otros módulos se registren sus rutinas de atención para ser invocadas cuando ocurren interrupciones. | ||
+ | |||
+ | <syntaxhighlight lang="C"> | ||
+ | addISRFunction(&timmerISRFunction); | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | Una forma que mantiene alta la cohesión del sistema es registrar módulos que se encarguen de esperar un evento en particular y brinde una interfaz para que los ''usermodules'' se registren para ser notificados de eventos generados por el componente de hardware que esta siendo modelado. Dentro de este módulo además se pueden brindar operaciones con mayor nivel de abstracción relacionadas con el componente a modelar. Hoy día se dispone del módulo T0service que se encarga de brindar servicio de timmers a los ''usermodules''. Al igual que el resto de los componentes funciona registrando funciones que son invocadas por el ''basefirmware'' | ||
+ | |||
+ | También existen funciones para desregistrar los ''usermodules'' de las notificaciones, es conveniente realizar la desregistración en la función que implementa el evento de liberación de recursos del módulo. | ||
+ | |||
+ | Por ahora el único componente de hardware del microcontrolador modelado de esta forma es el timmer, pero puede escalarse a otros que requieran ser compartidos por más de un módulo. | ||
+ | Hay que recordar que la concurrencia implementada es puramente colaborativa entre ''usermodules'' por lo cual se debe tener especial cuidado al programar las funciones que atienden estos eventos ya que si se queda "colgada" va a degradar la disponibilidad de todo el sistema. | ||
+ | |||
+ | Para agregar el ''usermodule'' a la placa de entrada/salida ''usb4all baseboard'' se debe agregar al proyecto el módulo (utilizando el IDE preferido) y realizar la compilación del proyecto | ||
+ | |||
+ | == 7. Servicios de Timers - T0Service == | ||
+ | |||
+ | T0service es un módulo encargado de brindar primitivas a los ''user modules'' para ser notificados de eventos del timmer. | ||
+ | La API expuesta es la siguiente: | ||
+ | |||
+ | <syntaxhighlight lang="C"> | ||
+ | /* | ||
+ | Registers a new event callback, to be called t time units in the future. | ||
+ | This function must not be called from a callback handler. | ||
+ | */ | ||
+ | BOOL registerT0event(unsigned int t, void (*callback)(void)); | ||
+ | |||
+ | /* | ||
+ | Registers a new event callback, to be called t time units in the future. | ||
+ | This function only can be called from a callback handler. | ||
+ | */ | ||
+ | BOOL registerT0eventInEvent(unsigned int t, void (*callback)(void)); | ||
+ | |||
+ | /* | ||
+ | Unregister a event callback. No pending event(s) will invoke it. | ||
+ | */ | ||
+ | BOOL unregisterT0event(void (*callback)(void)); | ||
+ | |||
+ | /* | ||
+ | Initialize the service | ||
+ | */ | ||
+ | void initT0Service(void); | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | |||
+ | |||
+ | Estas funciones son implementadas utilizando interrupciones, lo que permite que se interrumpa el código que está ejecutando en los ''usermodules'' para notificarlos de que ocurrió el vencimiento de tiempo que deseaban. | ||
+ | |||
+ | == 8. Detalles de implementación en el firmware == | ||
+ | |||
+ | El firmware está organizado en diferentes áreas que se mapean en secciones definidas dentro de la memoria ROM correspondiente a la memoria de programa del microcontrolador, para implementar esto se necesita especificar en un archivo llamado linker script dónde están alojadas físicamente (en memoria) estas secciones. | ||
+ | La forma de realizar este mapeo es editando el archivo lrk asociado al proyecto. | ||
+ | Existe la directiva CODEPAGE que es utilizada para trabajar con las secciones de programa, permite inicializar datos, constantes, y realizar referencias a las mismas. Tiene el siguiente formato | ||
+ | |||
+ | CODEPAGE NAME=memName START=addr END=addr [PROTECTED] [FILL=fillvalue] | ||
+ | |||
+ | donde: | ||
+ | memName es un string ASCII utilizado para identificar una CODEPAGE. | ||
+ | |||
+ | También existe la directiva DATABANK que permite realizar un manejo similar pero sobre la memoria de datos. | ||
+ | |||
+ | La directiva #pragma | ||
+ | El estándar ANSI C provee a cada implementación de un método para definir constructores únicos, según sea requerido por la arquitectura del procesador a utilizar. Esto es hecho utilizando la directiva #pragma. La directiva #pragma más común en el compilador utilizado (MPLAB C18) identifica la sección de memoria para ser utilizada en el PIC18XXXX. Por ejemplo #pragma code le indica al compilador MPLAB 18 que compile el código C en la sección de programa de la memoria de programa. La sección de código está definida en el linker script asociado para cada dispositivo PIC18XXXX, especificando en que áreas de la memoria de programa pueden ser ejecutadas instrucciones. | ||
+ | Esta directiva puede ser insertada directamente o puede ser seguida de la dirección en el área de código del procesador destino, permitiendo tener un control total del a memoria de código. | ||
+ | En el contexto del USB4all esto es muy utilizado, debido a que se separan varias áreas de memoria, las más importantes son la del bootloader, y la correspondiente a los módulos de usuario, tanto para la parte de programa (module_sec) como para la información del módulo que se almacena para gestionarlo (user_sec). | ||
+ | Otra directiva #pragma común que se utiliza es #pragma udata, la cual se utiliza cuando se aloja memoria para variables, las variables no inicianlizadas definidas después de esta declaración van a utilizar los registros de proposito general para almacenamiento. La arquitectura del PIC18XXXX, se basa en una arquitectura harvard la que a diferencia de la von neumann almacena las variables y las instrucciones en diferentes espacios de memoria. Por tanto las áreas de memoria deben ser explicitamente identificadas. | ||
+ | |||
+ | Por más información, consultar con el manual del compilador C18 (http://www.kevin.org/frc/C18_3.0_getting_started.pdf) en la sección #pragma DIRECTIVE o SECTIONS. | ||
+ | |||
+ | De la forma que se definieron las secciones en el archivo lkr del proyecto (18f4550.lkr) se debe colocar un #pragma code module al comenzar la declaración de los procedimientos del módulo, de esa forma se almacenan en memoria de programa (code section) dentro de la sección module. Si consultamos el linker script podemos ver que está definida la sección module como un alias del área en ROM llamada module_sec | ||
+ | |||
+ | SECTION NAME=module ROM=module_sec | ||
+ | |||
+ | a su vez module_sec es definida como: | ||
+ | |||
+ | CODEPAGE NAME=module_sec START=0x40AB END=0x8000 PROTECTED | ||
+ | |||
+ | Lo mismo se debe hacer cuando se definen las funciones que utiliza el módulo para atender eventos y su nombre (estructura uTab): | ||
− | '' | + | #pragma romdata user |
− | + | uTab userBuzzerModuleTable = {&UserBuzzerInit,&UserBuzzerRelease,&UserBuzzerConfigure,"buzzer"}; | |
+ | Como vimos en el ejemplo presentado en la sección escribiendo un ''user module''. | ||
+ | Hay que tener cuidado de no olvidarse de los #pragmas correspondientes ya que de de lo contrario puede no dar el espacio para compilar el proyecto o no funcionar el mecanismo de callbacks. | ||
+ | Los archivos lkr también especifican otros conceptos, como ser tamaño de memoria de datos y registros que utiliza, como también tamaño del stack | ||
− | |||
− | + | == ANEXO 1 == | |
− | + | En el enlace [http://sourceforge.net/p/usb4all/code/ci/6ecc2581f50519fe427f7a3947136c2a03108841/tree/firmware/u4a2/user/usr_buzzer.c] y [http://sourceforge.net/p/usb4all/code/ci/6ecc2581f50519fe427f7a3947136c2a03108841/tree/firmware/u4a2/user/usr_buzzer.h] puede descargarse el código completo del ejemplo presentado como caso de estudio. El mismo puede usarse como esqueleto para desarrollar otros ''user modules'' | |
+ | ---- | ||
El proyecto USB4all se encuentra disponible bajo licencia GNU/GPL v2 en el [http://sourceforge.net/projects/usb4all/ repositorio sorceforge] <br> | El proyecto USB4all se encuentra disponible bajo licencia GNU/GPL v2 en el [http://sourceforge.net/projects/usb4all/ repositorio sorceforge] <br> | ||
Este proyecto surge originalmente como un trabajo de [http://www.fing.edu.uy/inco/grupos/mina/pGrado/pgusb tesis de grado] en Ingeniería en Computación de Aguirre, Fernandez y Grossy. | Este proyecto surge originalmente como un trabajo de [http://www.fing.edu.uy/inco/grupos/mina/pGrado/pgusb tesis de grado] en Ingeniería en Computación de Aguirre, Fernandez y Grossy. |
Revisión actual del 16:03 17 abr 2015
Contenido
1. Motivación
La motivación de este proyecto se centra en lograr de una manera sencilla, la comunicación entre un sistema computador y un conjunto de dispositivos electrónicos no necesariamente pensados para interactuar con una computadora. Durante muchos años la única forma de interactuar con dispositivos externos desde a un computador personal (Personal Computer) (PC) fueron los puertos seriales y paralelos, esto llevo a que se utilizaran ampliamente en multiplicidad de dispositivos. Sus principales características son su simplicidad de manejo vía software y facilidad de inclusión en distintos dispositivos. En la última década han aparecido nuevos medios o canales de comunicación, tales como Bluetooth, Fidelidad Inalámbrica (Wireless Fidelity) (WiFi), FireWire, Bus Universal en Serie (Universal Serial Bus) (USB), etc. Estos permitieron mejorar las velocidades de comunicación y calidad de datos y lentamente tornaron a los puertos paralelos y seriales en obsoletos, hasta llegar al día de hoy en que se obtienen sólo de manera opcional en los nuevos PC. Dentro de todas estas nuevas tecnologías que aparecieron la que tuvo mayor aceptación y difusión entre los usuarios fue el USB, debido a su facilidad y versatilidad de escenarios de uso. Esta simplicidad desde el punto de vista del usuario de los dispositivos USB tiene como contrapartida una mayor complejidad para los desarrolladores de software y hardware, lo cual es un gran problema al momento de interactuar con dispositivos electrónicos. Frente a estas adversidades que presenta el entorno actual aparece la necesidad de buscar una forma de reducir el grado de complejidad y conocimientos necesarios para poder desarrollar software que utilice la tecnología USB. Al mismo tiempo, se requiere una plataforma base que incorpore componentes de hardware reutilizables y que en conjunto formen una solución genérica para la comunicación con dispositivos electrónicos diversos. En el contexto de lo antedicho aparecen un conjunto de desafíos como son el desarrollo de controladores (drivers) y construcción de piezas de hardware que brinde una solución genérica reutilizable, desplazando el manejo de los casos particulares a componentes específicos. Esto proporciona el beneficio de evitar que cada vez que se necesite conectar un nuevo dispositivo, se comience desde cero. A su vez permite recuperar y potenciar la característica de facilidad de manejo que poseían los puertos seriales y paralelos, explotando todas las capacidades brindadas por USB.
2. Arquitectura (Firmware/Hardware)
La arquitectura está compuesta por diferentes componentes, los cuales van a permitir el funcionamiento del sistema desde lo relativo al hardware como las abstracciones necesarias para manejarlo mediante software.
Los componentes principales son:
2.1 USB4all Baseboard
Es una placa de entrada/salida(E/S) configurable que se conecta por USB con un sistema computador. El proyecto USB4all es mucho más que una placa de E/S, en sí es una forma de modelar sistemas embebidos, siendo la placa de E/S un componente que fue necesario construir para desarrollar la solución completa. Para la construcción de esta placa se utilizó un microcontrolador PIC18F4550 de Microchip. Entre las características más destacadas en lo que concierne al proyecto se encuentra el soporte completo del estándar USB, pudiéndose utilizar varias de sus características, como ser diferentes tipos de transferencias y varios canales de comunicación (endpoints). El diseño de hardware de la placa puede descargarse del git del proyecto permitiendo que cualquiera pueda armarse una USB4all baseboard utilizando el software GPL Kicad.
2.2 USB4all base firmware
Es el firmware más estático, brinda servicios a los usermodules para que puedan utilizar los recursos presentes en la baseboard (timmers, puerto USB, conversores A/D, etc) además de brindar las primitivas para el intercambio de mensajes entre el computador y el usermodule y realiza la gestión de los usermodules. Establece las bases para que los usermodules sean independientes del protocolo de comunicación computador/placa y de los detalles de hardware del microcontrolador utilizado. A su vez oferce un entorno de ejecución concurrente que permite instanciar de forma dinámica varios usermodules.
2.3 USB4all usermodule
Son los componentes intercambiables del sistema que permiten encapsular la lógica de un dispositivo especifico y su protocolo de comunicación con las aplicaciones de usuario. Permite al usuario dar rápidamente soporte a un nuevo dispositivo de forma genérica, expandiendo de esta manera las funcionalidades del USB4all basefirmware. Los user modules son los bloques principales sobre los que se construye la arquitectura USB4all. Exponen una API uniforme que es utilizada a modo de callbacks por el base firmware y también exponen los servicios que brindan los dispositivos. Es recomendable modelar cada uno de los dispositivos electrónicos conectados a la baseboard como un usermodule donde los servicios a exponer se mapean con las características del mismo, como ejemplo en el caso de un motor, sería esperable que expusiera servicios para moverse, cambiar la velocidad y el sentido.
Del lado del sistema computador se dispone de diferentes formas de interacción: Todas ellas implementan el protocolo USB4all, su objetivo es abstraer al usuario del mismo brindando una forma sencilla de utilizar el sistema, existiendo soporte para diferentes lenguajes de programación. El objetivo principal de las bibliotecas utilizadas en el computador son las de permitir utilizar los servicios de los usermodules. Esta forma de trabajo permite desarrollar la lógica de interacción entre los diferentes dispositivos electrónicos dentro del sistema computador, con lenguajes de mayor abstracción, mejores herramientas de desarrollo, permitiendo generar un código con un nivel de mantenibilidad y abstracción mayor al que se lograría si todo estuviera embebido en el microcontrolador.
Uno de los componentes más usados actualmente es el bobot que persigue un enfoque genérico al igual que el proyecto USB4all y permite acompañar la extensibilidad de la placa USB4all mediante el uso de ciertos componentes propios de la arquitectura llamados drivers.
3. Protocolo de Comunicación
El protocolo está formado por un stack de protocolos que permiten abstraer al usuario de los detalles subyacentes de la arquitectura. El objetivo final del protocolo de comunicación, es direccionar los mensajes provenientes desde la aplicación que se ejecuta en el computador, al usermodule correspondiente ejecutado en la placa USB4all. Estos mensajes son solicitudes de ciertos servicios que los módulos exponen, por ejemplo en el caso de un dispositivo sonoro (buzzer) utilizado para una alarma, va a ser de interés poder emitir sonido (Prender el Buzzer) detener la emisión de sonido (Apagar el Buzzer), hacer sonidos cortos pasando por parámetro la cantidad de milisegundos que se desea esté prendido, etc. Estos mensajes se tienen que codificar de alguna manera, el protocolo especifica que primero se debe indicar el comando que se desea se ejecute y luego en caso que sea necesario (como en el de los sonidos cortos) enviar los parámetros. En algunos casos va a ser necesario obtener respuestas, las cuales se codifican de forma análoga usando el mismo protocolo, enviando en lugar de un parámetro un valor de retorno. Este protocolo es llamado user protocol y está enfocado al usuario final, pero para que el sistema funcione correctamente es necesario contar con otros protocolos los cuales transportan el protocolo user protocol. Tal es el caso del handler manager protocol que se encarga de manejar el ruteo de los mensajes al user module correspondiente. Esto se debe a que en un momento determinado puede haber varios user modules ejecutando en la placa y el sistema debe permitir notificar del nuevo mensaje al módulo para el cual está destinado el mismo. La tarea fundamental de este protocolo es brindar los mecanismos para comunicar una aplicación con un user module. Otro protocolo involucrado es el admin protocol el cual se encarga de gestionar el ciclo de vida de los user modules, permitiendo poner a ejecutar un user module, cerrarlo y también algunas funcionalidades como el listar los módulos presentes en la placa, cerrar todos los modulos abiertos o llevar al estado de reset al microcontrolador. Tanto el handler protocol como el admin protocol son implementados por las bibliotecas que se utilicen en el computador. Existiendo varias opciones, Java, Python o Lua. Actualmente la opción que se está manteniendo es la de Lua, la cual puede estudiarse en profundidad en la sección bobot.
Finalmente los paquetes USB4all se trasmiten por el protocolo de comunicación que disponga el baseboard, para el caso típico del baseboard usb4all se trasmite mediante USB, pero puede ser trasmitido mediante otras tecnologías utilizadas para comunicarse con un computador, como ser serial o bluetooth (entre otros).
4. Grabando el Firmware
Para grabar el firmware se necesita disponer de un programador hardware, como el picdem o el pickit, este último tiene buen soporte dentro de GNU/Linux. Microchip distribuye un bootloader para la familia de microcontroladores 18F. Un bootloader es un programa que se utiliza para grabar y/o actualizar el firmware. En nuestro caso, va a permitr grabar el firmware del proyecto USB4all sin la necesidad de disponer de un programador por hardware, para realizar esto es necesario dejar presionado el botón de programación como puede verse en la figura 4.1 mientras se resetea la placa con el botón de reset. Esto funciona siempre y cuando el microcontrolador tenga grabado el bootloader. Una vez que el dispositivo se encuentra en modo programación su identificador de producto cambia de 000c a 000b, esto puede verificarse utilizando el comando lsusb cuya salida se adjunta para los dos casos a continuación:
Id dispositivo USB4all
Bus 002 Device 002: ID 04d8:000c Microchip Technology, Inc.
id dispositivo Bootloader
Bus 002 Device 003: ID 04d8:000b Microchip Technology, Inc.
Dado que Microchip no distribuye microcontroladores con el bootlader previamente grabado, es necesario utilizar un programador por hardware para grabar el bootloader. USB4all actualmente utiliza un bootloader modificado que permite actualizar el firmware programáticamente sin necesidad de presionar los botones, útil a la hora de realizar actualizaciones remotas, pero responde a los mismos comandos que el bootloader de Microchip, lo cual permite reutilizar el software ya desarrollado para interactuar con el bootloader. Los fuentes del bootloader pueden encontrarse en el repositorio en el directorio bootloader del firmware, es un proyecto separado y una vez compilado su grabación se realiza mediante un programador por hardware como picdem o pickit. Una vez grabado el bootloader ya no es necesario utilizar programadores por hardware y puede realizarse la grabación del firmware mediante varios programas que implementan el protocolo de grabación de firmware de microchip. Una de esas utilidades es el programa fsusb el cual puede encontrarse en [1] y es de código libre. Su uso se realiza de la siguiente forma:
./fsusb --program usb4all2.hex
Donde usb4all2.hex es el binario generado como resultado de compilar el proyecto. Recordar que el hardware debe estar en modo bootloader para poder recibir el firmware.
4.1 Grabando Bootloader + Firmware
Una manera rápida, luego que se tiene acceso a un programador, es grabar el bootloader correspondiente y algún firmware (todo junto). Para eso pueden usar este .hex:
Nota. Ahora es posible grabar el firmware fácilmente mediante la siguiente actividad Grabar Firmware.
5. Entorno de desarrollo
El proyecto USB4all está desarrollado para el compilador C18 de Microchip, hoy día se dispone de un buen soporte del mismo para GNU/Linux pudiéndose descargar de [2] también se dispone de un entorno de desarrollo llamado MPLab el cual también se encuentra disponible para GNU/Linux en la misma dirección.
Hace un tiempo atrás no existía compatibilidad para GNU/Linux de estas herramientas clásicas para los ambientes Windows en GNU/Linux. Debiéndose recurrir a alternativas para trabajar en un ambiente GNU/Linux, una opción era Piklab. Piklab es un entorno de desarrollo para trabajar con microcontroladores PIC similar a lo que es MPLab. Era muy común utilizar la versión de C18 de Windows emulada mediante wine en GNU/Linux debiéndose configurar en las opciones de toolchain de PIKLab correspondientes a C18 para que apunten correctamente a los directorios donde se encuentra el compilador C18. En el repositorio puede encontrarse un proyecto piklab configurado de esta manera. Más información sobre la configuración de c18 con piklab en linux (deprecated) ver: [3]
Luego de compilar, cargar el binario generado (.hex) en la placa mediante el uso del bootloader que se incluye en el firmware. Esto puede realizarse utilizando la herramienta fsusb como se describe en la sección Grabando el Firmware.
Nota. Para sistemas de 64 bits se debe tener instalada la librería ia32-libs.
6. Escribiendo un usermodule
Un usermodule es el bloque sobre el cual se representa una realidad y se modela utilizando la arquitectura USB4all, en esta sección se presentan sus características, estructura necesaria para especificar los servicios que brinda y de que forma se anexa al basefirmware
6.1 Estructura de un usermodule:
Un usermodule debe cumplir con una API determinada, de esta manera es posible agregar las funcionalidades que el módulo expone, dentro del basefirmware.
Las operaciones principales que se deben implementar son las encargadas de atender los eventos de:
- inicialización
- liberación de recursos
- configuración
Estas operaciones se ejecutan en determinados momentos del ciclo de vida de una aplicación USB4all, siendo la operación registrada al evento de inicialización invocada al abrir desde la aplicación el usermodule y la de liberación de recursos al cerrarlo, esto permite utilizar los recursos del microcontrolador solo cuando es necesario. La operación de configuración puede invocarse en cualquier momento para cambiar en caliente algún aspecto de configuración del hardware. Al comenzar un usermodule se debe declarar cuales van a ser las funciones que van a atender estos eventos y el nombre del módulo para ser identificado desde el computador al listar los módulos presentes en la placa.
#pragma romdata user uTab userBuzzerModuleTable = {&UserBuzzerInit,&UserBuzzerRelease,&UserBuzzerConfigure,"buzzer"}; #pragma code
Donde user es el nombre de la sección y uTab es una estructura para almacenar las posiciones de memoria de las operaciones que exporta el módulo y su nombre. En la sección detalles de implementación en el firmware se puede conocer más sobre el significado de la instrucción #pragma romdata user, podemos por el momento asumir que sirve para almacenar la estructura uTab en un lugar conocido dentro de la memoria de programa.
El basefirmware se encarga de pasar como argumento a la operación init el número de handler asignado al módulo, este número es utilizado como argumento en otras operaciones como ser setHandlerReceiveFunction la cual recibe por parámetro el handler y un puntero a la función encargada de manejar la recepción de datos. Otra operación que necesita el handlerID es getSharedBuffer la cual recibe por parámetro el handlerID del módulo y retorna un buffer por el cual el módulo puede enviar datos a la aplicación que ejecuta en el computador. Un buen lugar para obtener este buffer y registrar la función de recepción de datos es la operación encargada del evento de inicialización. A continuación puede verse como ejemplo la inicialización de un módulo de usuario para controlar un buzzer:
void UserBuzzerInit(byte i) {
usrBuzzerHandler = i;
// add my receive function to the handler module, to be called automatically when the pc sends data to the user module
setHandlerReceiveFunction(usrBuzzerHandler,&UserBuzzerReceived);
// initialize the send buffer, used to send data to the PC
sendBufferUsrBuzzer = getSharedBuffer(usrBuzzerHandler);
}//end UserBuzzerInit
La función de recepción de datos es la encargada de implementar el protocolo de comunicación entre el usermodule y la aplicación, típicamente es una estructura tipo case en el que se espera por los diferentes comandos que pueden enviarse. La forma de codificar el pedido de servicios es mediante mensajes del tipo < COMANDO [argumento1] [argumento2]...[argumentoN] >. La respuesta debe ser del tipo < COMANDO [resultado1] [resultado2]..[resultadoN] >. El buffer para enviar datos al computador es obtenido como argumento de la función y el buffer para enviar datos fue obtenido previamente en la función de inicialización.
void UserBuzzerReceived(byte* recBuffPtr, byte len){
byte index;
byte j;
byte userBuzzerCounter = 0;
byte tiempo;
switch(((BUZZER_DATA_PACKET*)recBuffPtr)->CMD){
case READ_VERSION:
//dataPacket._byte[1] is len
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0];
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1];
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[2] = BUZZER_MINOR_VERSION;
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[3] = BUZZER_MAJOR_VERSION;
userBuzzerCounter = 0x04;
break;
case PRENDER:
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0];
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1];
buzzer_on();
userBuzzerCounter = 0x02;
break;
case APAGAR:
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0];
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1];
buzzer_off();
userBuzzerCounter = 0x02;
break;
case BUZZER_TRIPLE:
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0];
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1];
cantTicks1 = (byte)(((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1]);
cantTicks2 = (byte)(((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[2]);
cantTicks3 = (byte)(((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[3]);
boubleBeep(cantTicks1, cantTicks2, cantTicks3);
userBuzzerCounter = 0x02;
break;
case BUZZER_CORTO:
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[0] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[0];
((BUZZER_DATA_PACKET*)sendBufferUsrBuzzer)->_byte[1] = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1];
cantTicks3 = ((BUZZER_DATA_PACKET*)recBuffPtr)->_byte[1];
timeOutTicksBuzz = 1; // lo seteo timmer para que venza inmediantamente
buzzerState = DELAY;
registerT0event(0, &buzzEvent);
userBuzzerCounter = 0x02;
break;
case RESET:
Reset();
break;
default:
break;
}//end switch(s)
if(userBuzzerCounter != 0){
j = 255;
while(mUSBGenTxIsBusy() && j-->0); // pruebo un máximo de 255 veces
if(!mUSBGenTxIsBusy())
USBGenWrite2(usrBuzzerHandler, userBuzzerCounter);
}//end if
}//end UserBuzzerReceived
En este ejemplo se puede apreciar como se reciben los pedidos de comandos desde la aplicación que ejecuta en el computador y como se obtienen los parámetros necesarios para implementar los comandos y se devuelven los datos (en caso de ser requeridos) a la aplicación.
6.2 Entrada/Salida en user modules:
Una de las tareas más importantes de los usermodules es la de realizar entrada/salida con diferentes periféricos electrónicos. Para realizar esta tarea existen dos paradigmas:
- Polling
- Interrupciones
Dentro de la arquitectura USB4all existen formas de que los módulos implementen entrada/salida utilizando estos paradigmas, para el caso de pooling existe un servicio que permite registrar una función para ser ejecutada cuando el procesador esté disponible.
addPollingFunction(&UserBuzzerProcessIO);
Existe soporte para interrupciones mediante el módulo DynamicISR el cual permite que otros módulos se registren sus rutinas de atención para ser invocadas cuando ocurren interrupciones.
addISRFunction(&timmerISRFunction);
Una forma que mantiene alta la cohesión del sistema es registrar módulos que se encarguen de esperar un evento en particular y brinde una interfaz para que los usermodules se registren para ser notificados de eventos generados por el componente de hardware que esta siendo modelado. Dentro de este módulo además se pueden brindar operaciones con mayor nivel de abstracción relacionadas con el componente a modelar. Hoy día se dispone del módulo T0service que se encarga de brindar servicio de timmers a los usermodules. Al igual que el resto de los componentes funciona registrando funciones que son invocadas por el basefirmware
También existen funciones para desregistrar los usermodules de las notificaciones, es conveniente realizar la desregistración en la función que implementa el evento de liberación de recursos del módulo.
Por ahora el único componente de hardware del microcontrolador modelado de esta forma es el timmer, pero puede escalarse a otros que requieran ser compartidos por más de un módulo. Hay que recordar que la concurrencia implementada es puramente colaborativa entre usermodules por lo cual se debe tener especial cuidado al programar las funciones que atienden estos eventos ya que si se queda "colgada" va a degradar la disponibilidad de todo el sistema.
Para agregar el usermodule a la placa de entrada/salida usb4all baseboard se debe agregar al proyecto el módulo (utilizando el IDE preferido) y realizar la compilación del proyecto
7. Servicios de Timers - T0Service
T0service es un módulo encargado de brindar primitivas a los user modules para ser notificados de eventos del timmer. La API expuesta es la siguiente:
/*
Registers a new event callback, to be called t time units in the future.
This function must not be called from a callback handler.
*/
BOOL registerT0event(unsigned int t, void (*callback)(void));
/*
Registers a new event callback, to be called t time units in the future.
This function only can be called from a callback handler.
*/
BOOL registerT0eventInEvent(unsigned int t, void (*callback)(void));
/*
Unregister a event callback. No pending event(s) will invoke it.
*/
BOOL unregisterT0event(void (*callback)(void));
/*
Initialize the service
*/
void initT0Service(void);
Estas funciones son implementadas utilizando interrupciones, lo que permite que se interrumpa el código que está ejecutando en los usermodules para notificarlos de que ocurrió el vencimiento de tiempo que deseaban.
8. Detalles de implementación en el firmware
El firmware está organizado en diferentes áreas que se mapean en secciones definidas dentro de la memoria ROM correspondiente a la memoria de programa del microcontrolador, para implementar esto se necesita especificar en un archivo llamado linker script dónde están alojadas físicamente (en memoria) estas secciones. La forma de realizar este mapeo es editando el archivo lrk asociado al proyecto. Existe la directiva CODEPAGE que es utilizada para trabajar con las secciones de programa, permite inicializar datos, constantes, y realizar referencias a las mismas. Tiene el siguiente formato
CODEPAGE NAME=memName START=addr END=addr [PROTECTED] [FILL=fillvalue]
donde: memName es un string ASCII utilizado para identificar una CODEPAGE.
También existe la directiva DATABANK que permite realizar un manejo similar pero sobre la memoria de datos.
La directiva #pragma El estándar ANSI C provee a cada implementación de un método para definir constructores únicos, según sea requerido por la arquitectura del procesador a utilizar. Esto es hecho utilizando la directiva #pragma. La directiva #pragma más común en el compilador utilizado (MPLAB C18) identifica la sección de memoria para ser utilizada en el PIC18XXXX. Por ejemplo #pragma code le indica al compilador MPLAB 18 que compile el código C en la sección de programa de la memoria de programa. La sección de código está definida en el linker script asociado para cada dispositivo PIC18XXXX, especificando en que áreas de la memoria de programa pueden ser ejecutadas instrucciones. Esta directiva puede ser insertada directamente o puede ser seguida de la dirección en el área de código del procesador destino, permitiendo tener un control total del a memoria de código. En el contexto del USB4all esto es muy utilizado, debido a que se separan varias áreas de memoria, las más importantes son la del bootloader, y la correspondiente a los módulos de usuario, tanto para la parte de programa (module_sec) como para la información del módulo que se almacena para gestionarlo (user_sec). Otra directiva #pragma común que se utiliza es #pragma udata, la cual se utiliza cuando se aloja memoria para variables, las variables no inicianlizadas definidas después de esta declaración van a utilizar los registros de proposito general para almacenamiento. La arquitectura del PIC18XXXX, se basa en una arquitectura harvard la que a diferencia de la von neumann almacena las variables y las instrucciones en diferentes espacios de memoria. Por tanto las áreas de memoria deben ser explicitamente identificadas.
Por más información, consultar con el manual del compilador C18 (http://www.kevin.org/frc/C18_3.0_getting_started.pdf) en la sección #pragma DIRECTIVE o SECTIONS.
De la forma que se definieron las secciones en el archivo lkr del proyecto (18f4550.lkr) se debe colocar un #pragma code module al comenzar la declaración de los procedimientos del módulo, de esa forma se almacenan en memoria de programa (code section) dentro de la sección module. Si consultamos el linker script podemos ver que está definida la sección module como un alias del área en ROM llamada module_sec
SECTION NAME=module ROM=module_sec
a su vez module_sec es definida como:
CODEPAGE NAME=module_sec START=0x40AB END=0x8000 PROTECTED
Lo mismo se debe hacer cuando se definen las funciones que utiliza el módulo para atender eventos y su nombre (estructura uTab):
#pragma romdata user uTab userBuzzerModuleTable = {&UserBuzzerInit,&UserBuzzerRelease,&UserBuzzerConfigure,"buzzer"};
Como vimos en el ejemplo presentado en la sección escribiendo un user module. Hay que tener cuidado de no olvidarse de los #pragmas correspondientes ya que de de lo contrario puede no dar el espacio para compilar el proyecto o no funcionar el mecanismo de callbacks. Los archivos lkr también especifican otros conceptos, como ser tamaño de memoria de datos y registros que utiliza, como también tamaño del stack
ANEXO 1
En el enlace [4] y [5] puede descargarse el código completo del ejemplo presentado como caso de estudio. El mismo puede usarse como esqueleto para desarrollar otros user modules
El proyecto USB4all se encuentra disponible bajo licencia GNU/GPL v2 en el repositorio sorceforge
Este proyecto surge originalmente como un trabajo de tesis de grado en Ingeniería en Computación de Aguirre, Fernandez y Grossy.