Herramientas de usuario

Herramientas del sitio


docu:fw:bm:estructura

Diferencias

Muestra las diferencias entre dos versiones de la página.

Enlace a la vista de comparación

docu:fw:bm:estructura [2015/04/04 06:17]
mcerdeiro documentar directorios
docu:fw:bm:estructura [2015/04/12 09:31] (actual)
mcerdeiro agregar barra
Línea 1: Línea 1:
 ====== Estructura de directorios ====== ====== Estructura de directorios ======
- 
-El CIAA-Firmware está construido de forma modular. 
  
 ### ###
 +El CIAA-Firmware está construido de forma modular. Para la mayoria de los usuarios puede que alcance saber que existe un directorio de ejemplos (examples). Esta página es para aquellos que quieran conocer un poco más en detalle la estructura del Firmware.
 +
 En el directorio principal luego de hacer un [[desarrollo:​firmware:​git|git clone]] o al bajar una release oficial se pueden encontrar los siguientes Directorios y Archivos: En el directorio principal luego de hacer un [[desarrollo:​firmware:​git|git clone]] o al bajar una release oficial se pueden encontrar los siguientes Directorios y Archivos:
 ### ###
Línea 10: Línea 10:
 Firmware/ Firmware/
 ├── doc ├── doc
-├── examples ​                     /* ejemplos de utilización del Firmware */ +├── examples ​                  ​/* ejemplos de utilización del Firmware */ 
-│   ├── adc_dac ​                  ​/* ejemplo de conversor analogico digital */ +│   ├── adc_dac ​               /* ejemplo de conversor analogico digital */ 
-│   ├── blinking ​                 /* ejemplo básico que hace parpadear un led */ +│   ├── blinking ​              ​/* ejemplo básico que hace parpadear un led */ 
-│   ├── blinking_echo ​            ​/* ejemplo básico que hace echo en el bus serial */ +│   ├── blinking_echo ​         /* ejemplo básico que hace echo en el bus serial */ 
-│   ├── blinking_lwip ​            ​/* ejemplo utilizando lwip (ethernet) */ +│   ├── blinking_lwip ​         /* ejemplo utilizando lwip (ethernet) */ 
-│   ├── blinking_modbus ​          ​/* ejemplo utilizando modbus RS485 (ascii) */ +│   ├── blinking_modbus ​       /* ejemplo utilizando modbus RS485 (ascii) */ 
-│   ├── blinking_modbus_master ​   /* ejemplo utilizando modbus master */ +│   ├── blinking_modbus_master /* ejemplo utilizando modbus master */ 
-│   └── rtos_example ​             /* ejemplo de utilización de FreeOSEK */+│   └── rtos_example ​          ​/* ejemplo de utilización de FreeOSEK */
 ├── externals ├── externals
-│   ├── base                      /* archivos básicos necesarios para compilar/​linkear */ +│   ├── base                   ​/* archivos básicos necesarios para compilar/​linkear */ 
-│   ├── ceedling ​                 /* ceedling utilidad para correr los unit test */ +│   ├── ceedling ​              ​/* ceedling utilidad para correr los unit test */ 
-│   ├── drivers ​                  ​/* drivers para el módulo posix */ +│   ├── drivers ​               /* drivers para el módulo posix */ 
-│   ├── lcov                      /* utilidad para analizar el coverage de los unit test */ +│   ├── lcov                   ​/* utilidad para analizar el coverage de los unit test */ 
-│   └── lwip                      /* stack tcpip */+│   └── lwip                   ​/* stack tcpip */
  
-├── Makefile ​                     /* makfile principal del proyecto */ +├── Makefile ​                  ​/* makfile principal del proyecto */ 
-├── Makefile.config ​              ​/* plantilla para crear un Makefile.mine propio */ +├── Makefile.config ​           /* plantilla para crear un Makefile.mine propio */ 
-├── Makefile.mine ​                ​/* Makfile con la configuración del usuario */+├── Makefile.mine ​             /* Makfile con la configuración del usuario */
  
-├── modules ​                      ​/* módulos del Firmware */ +├── modules ​                   /* módulos del Firmware */ 
-│   ├── base                      /* archivos básicos necesarios para compilar y linkear */ +│   ├── base                   ​/* archivos básicos necesarios para compilar y linkear */ 
-│   ├── ciaak                     ​/* kernel de la ciaa */ +│   ├── ciaak                  /* kernel de la ciaa */ 
-│   ├── drivers ​                  ​/* drivers para posix */ +│   ├── drivers ​               /* drivers para posix */ 
-│   ├── libs                      /* algunas librerias genéricas */ +│   ├── libs                   ​/* algunas librerias genéricas */ 
-│   ├── modbus ​                   /* módulo para manejo de modbus */ +│   ├── modbus ​                ​/* módulo para manejo de modbus */ 
-│   ├── plc                       ​/* módulo de PLC (en desarrollo) */ +│   ├── plc                    /* módulo de PLC (en desarrollo) */ 
-│   ├── posix                     ​/* posix like library */ +│   ├── posix                  /* posix like library */ 
-│   ├── rtos                      /* RTOS de CIAA-Firmware (FreeOSEK) */ +│   ├── rtos                   ​/* RTOS de CIAA-Firmware (FreeOSEK) */ 
-│   ├── systests ​                 /* utilidad para correr los tests en HW (en desarrollo) */ +│   ├── systests ​              ​/* utilidad para correr los tests en HW (en desarrollo) */ 
-│   ├── template ​                 /* template para crear un nuevo módulo */ +│   ├── template ​              ​/* template para crear un nuevo módulo */ 
-│   ├── tools                     ​/* tools internos de CIAA-Firmware */ +│   ├── tools                  /* tools internos de CIAA-Firmware */ 
-│   ​── update +│   ​── update ​                /* módulo de bootloader (en desarrollo) */ 
-│   └── wrappers +│ 
-├── out +├── out                        /* archivos generados */ 
-│   ├── bin +│   ├── bin                    /* archivo binario (proyecto a ser flasheado) */ 
-│   ├── ceedling +│   ├── gen                    /* archivos generados por el RTOS */ 
-│   ├── ci +│   ├── lib                    /* librerias */ 
-│   ├── coverage +│   ├── obj                    /* object files */ 
-│   ├── doc +│   └── ​...                    /* ... (para simplificar no se han listado todos los sub directorios) */
-│   ├── docbook +
-│   ├── gen +
-│   ├── lib +
-│   ├── obj +
-│   └── ​rtos+
 └── README └── README
 </​code>​ </​code>​
Línea 79: Línea 74:
  
 ===== externals (Software y Tools Externos) ===== ===== 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. 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.
Línea 85: Línea 81:
 ^ Directorio ^ Descripción ^ ^ Directorio ^ Descripción ^
 | ceedling | Tool utilizada para los [[unit_tests|Unit Tests o Pruebas Unitarias]] | | ceedling | Tool utilizada para los [[unit_tests|Unit Tests o Pruebas Unitarias]] |
-platforms ​Software utilizado para las plataformasdesde 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. |+base     Fuentesheaders y linker ​scripts necesarios ​para poder compilar y linkear el código en la plataforma | 
 +| drivers ​ | Drivers provistos por el proveedor del chip, los cuales son luego adaptados al formato de la CIAA. |
  
 ===== modules (Módulos de CIAA-Firmware) ===== ===== modules (Módulos de CIAA-Firmware) =====
Línea 97: Línea 94:
 ^ Directorio ^ Descripción ^ ^ 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 | | 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|Unit Tests o Pruebas Unitarias]] | 
-| doc | Contiene la documentación generada utilizando: <​code>​make doc</​code>​ | 
 | gen | Archivos generados de [[rtos|OSEK RTOS]] | | gen | Archivos generados de [[rtos|OSEK RTOS]] |
 | lib | Por cada Módulo el make genera un archivo .a, osea una libreria | | lib | Por cada Módulo el make genera un archivo .a, osea una libreria |
 +| obj | Todos los archivos fuentes son compilados a object files y almacenados en este directorio |
 +
 +<- docu:​fw:​bm:​woide|Trabajando sin IDE ^ ^ docu:​fw:​bm:​make|Make ->
docu/fw/bm/estructura.1428139077.txt.gz · Última modificación: 2015/04/04 06:17 por mcerdeiro