Herramientas de usuario

Herramientas del sitio

Traducciones de esta página:

docu:fw:bm:estructura

¡Esta es una revisión vieja del documento!


Estructura de directorios

El CIAA-Firmware está construido de forma modular.

En el directorio principal luego de hacer un git clone o al bajar una release oficial se pueden encontrar los siguientes Directorios y Archivos:

Firmware/
├── doc
├── examples
│   ├── adc_dac
│   ├── blinking
│   ├── blinking_echo
│   ├── blinking_lwip
│   ├── blinking_modbus
│   ├── blinking_modbus_master
│   └── rtos_example
├── externals
│   ├── base
│   ├── ceedling
│   ├── drivers
│   ├── lcov
│   └── lwip
├── Makefile
├── Makefile.config
├── Makefile.mine
├── modules
│   ├── base
│   ├── ciaak
│   ├── drivers
│   ├── libs
│   ├── modbus
│   ├── plc
│   ├── posix
│   ├── rtos
│   ├── systests
│   ├── template
│   ├── tools
│   ├── update
│   └── wrappers
├── out
│   ├── bin
│   ├── ceedling
│   ├── ci
│   ├── coverage
│   ├── doc
│   ├── docbook
│   ├── gen
│   ├── lib
│   ├── obj
│   └── rtos
└── README
Directorio o
Archivo
Descripción
.git Contiene archivos de GIT vinculados al manejo de este repositorio, no son parte en si de CIAA-Firmware. Solo estaran presentes en caso de haber clonado el repositorio. Si bajó una release los archivos no estarán presentes.
.gitignore
.gitmodules
doc Contiene la documentación básica del proyecto somo ser: Rlease Notes, Credits, Página de inicio de Doxygen y algunos diagramas UML
examples Contiene los ejemplos que se pueden utilizar de base para futuros desarrollos.
externals Contiene librerías o tools necesarios por CIAA-Firmware pero que no son parte directa de la CIAA y pueden contener otras licencias.
modules Contiene los módulos del CIAA-Firmware.
out Todos los archivos generados/salida, ya sean librerías, binarios o archivos generados son almacenados en este y sub directorios.
Makefile Este archivo es el makefile principal de CIAA-Firmware.
Makefile.config Contiene un ejemplo de como debería ser Makfile.mine.
Makefile.mine Es un archivo que el usuario debe crear basandose en Makefile.config. El mismo no se encuentra en el repositorio ni en las releases. Es propio de cada usuario. Debe crearse a partir de una copia de Makefile.config, puede encontrar más información en Make.

examples (Ejemplos del CIAA-Firmware)

Contiene los ejemplos de CIAA-Firmware. A todo aquel que comience a programar utilizando el CIAA-Firmware le recomendamos iniciar el proyecto basado en alguno de nuestros ejemplos.

En la sección TODO (examples) se estudiara cada ejemplo en más detalle.

externals (Software y Tools Externos)

Este directorio contiene el Software y Tools externos al CIAA-Firmware, que son necesarios para compilar, testear, etc. el Firmware. Tenga en cuenta que el Software y Tools en esta carpeta no son parte de CIAA-Firmware y pueden contener otras licencias.

Directorio Descripción
ceedling Tool utilizada para los Unit Tests o Pruebas Unitarias
platforms Software utilizado para las plataformas, desde scritps para el linker como códigos de startup para la inicialización del software. Con el tiempo intentaremos reescribir todas estas rutinas y scripts para que no sea necesario utilizar scripts o software externo.

modules (Módulos de CIAA-Firmware)

Contiene los módulos de software del CIAA-Firmware.

out (Archivos de salida)

Contiene todos los archivos generados por el CIAA-Firmware:

Directorio Descripción
bin Contiene el binario del proyecto, es el archivo que se va a correr en la PC o a cargar en el CIAA-Firmware
ceedling Contiene todo lo relevante a las salidas de los Unit Tests o Pruebas Unitarias
doc Contiene la documentación generada utilizando:
make doc
gen Archivos generados de OSEK RTOS
lib Por cada Módulo el make genera un archivo .a, osea una libreria
docu/fw/bm/estructura.1428137799.txt.gz · Última modificación: 2015/04/04 05:56 por mcerdeiro