Diseño de Firmware
Versión: 0.2
Fecha: AAAA-MM-DD
Responsable: [Nombre]
Estado: Borrador / En revisión / Aprobado
1. Descripción General (*)
| Parámetro | Valor |
|---|---|
| Plataforma / MCU | |
| Toolchain | |
| RTOS | |
| Lenguaje principal | |
| Versión del SDK/HAL | |
| Repositorio / Ruta | /firmware/ |
2. Versiones de Firmware (*)
| Versión | Fecha | Cambios principales | Compatibilidad HW | Estado |
|---|---|---|---|---|
Convención de versión:
MAYOR.MENOR.PARCHE
3. Arquitectura de Capas (*)
┌──────────────────────────────────────┐
│ Capa de Aplicación │
├──────────────────────────────────────┤
│ Servicios / Middleware │
├──────────────────────────────────────┤
│ Drivers / HAL │
├──────────────────────────────────────┤
│ RTOS / Scheduler / Bare-metal │
├──────────────────────────────────────┤
│ Hardware (MCU + Periféricos) │
└──────────────────────────────────────┘
4. Módulos de Firmware (*)
| Módulo | Descripción | Archivo(s) | Dependencias |
|---|---|---|---|
5. Tareas / Hilos — RTOS (○)
| Tarea | Prioridad | Stack (bytes) | Periodo / Evento | Descripción |
|---|---|---|---|---|
6. Configuración y Parámetros del Sistema (○)
| Parámetro | Define / Variable | Valor por defecto | Descripción |
|---|---|---|---|
7. Estándar de Código (○)
7.1 Convenciones de Nomenclatura
| Elemento | Convención | Ejemplo |
|---|---|---|
7.2 Comentarios y Documentación
7.3 Manejo de Errores
8. Interfaces de Firmware (○)
8.1 Entradas al Sistema
| Entrada | Tipo | Descripción | Pin / Interfaz |
|---|---|---|---|
8.2 Salidas del Sistema
| Salida | Tipo | Descripción | Pin / Interfaz |
|---|---|---|---|
8.3 Protocolo de Comunicación (○)
| Campo | Longitud | Descripción |
|---|---|---|
9. Decisiones de Diseño (*)
| # | Decisión | Alternativas | Razón | Fecha |
|---|---|---|---|---|
| 1 |
10. Restricciones de Recursos (○)
| Recurso | Disponible | Uso actual | Porcentaje |
|---|---|---|---|
| Flash | KB | KB | % |
| RAM | KB | KB | % |
11. Documentación del Código (○)
| Campo | Detalle |
|---|---|
| Herramienta | Doxygen |
| Archivo de configuración | /firmware/Doxyfile |
| Documentación generada (local) | /firmware/docs/html/index.html |
| Documentación publicada (○) | [URL del sitio generado, si se despliega] |
| Cobertura esperada | Todas las funciones públicas / Solo módulos críticos |
12. Historial de Cambios (*)
| Versión | Fecha | Autor | Cambios | Motivo |
|---|---|---|---|---|
| 0.1 | AAAA-MM-DD | Creación inicial | ||
| 0.2 | AAAA-MM-DD | Creación inicial |