错误类型¶
概述¶
tiny_error_type.h 定义了 TinySHM 中间件的 统一错误码系统。TinyMath、TinyDSP 和平台层中的每个函数都返回 tiny_error_t 类型的值,从而在整个代码库中实现一致的错误处理。
错误码采用 模块化命名空间 设计:每个主要模块被分配自己的 基偏移量,各个错误条件定义为相对于该基偏移量的偏移值。
错误码架构¶
%%{init: {'themeVariables': {'fontSize': '22px'}}}%%
graph LR
GEN["0x00xx<br/><b>通用</b>"]
WIFI["0x30xx<br/>WiFi"]
MESH["0x40xx<br/>Mesh"]
FLASH["0x60xx<br/>Flash"]
CRYPTO["0xC0xx<br/>加密"]
MEM["0xD0xx<br/>存储保护"]
MATH["0x70000<br/><b>TinyMath</b>"]
DSP["0x80000<br/><b>TinyDSP</b>"]
style MATH fill:#eef2ff,stroke:#4f6af5,stroke-width:2px
style DSP fill:#eef2ff,stroke:#4f6af5,stroke-width:2px 通用错误码¶
这些是所有中间件层使用的基本错误码:
| 代码 | 宏 | 说明 |
|---|---|---|
0 | TINY_OK | 成功——无错误 |
-1 | TINY_FAIL | 通用失败 |
0x101 | TINY_ERR_NO_MEM | 内存不足 |
0x102 | TINY_ERR_INVALID_ARG | 无效参数 |
0x103 | TINY_ERR_INVALID_STATE | 无效状态 |
0x104 | TINY_ERR_INVALID_SIZE | 无效大小 |
0x105 | TINY_ERR_NOT_FOUND | 未找到资源 |
0x106 | TINY_ERR_NOT_SUPPORTED | 不支持的操作 |
0x107 | TINY_ERR_TIMEOUT | 操作超时 |
0x108 | TINY_ERR_INVALID_RESPONSE | 收到无效响应 |
0x109 | TINY_ERR_INVALID_CRC | CRC 或校验和不匹配 |
0x10A | TINY_ERR_INVALID_VERSION | 无效版本 |
0x10B | TINY_ERR_INVALID_MAC | 无效 MAC 地址 |
0x10C | TINY_ERR_NOT_FINISHED | 操作尚未完全完成 |
0x10D | TINY_ERR_NOT_ALLOWED | 不允许的操作 |
其他模块基地址¶
这些基地址为其他 TinySHM 中间件模块预留(不属于 TinyMath/TinyDSP):
| 基地址 | 宏 | 模块 |
|---|---|---|
0x3000 | TINY_ERR_WIFI_BASE | WiFi 子系统 |
0x4000 | TINY_ERR_MESH_BASE | Mesh 组网 |
0x6000 | TINY_ERR_FLASH_BASE | Flash 存储 |
0xC000 | TINY_ERR_HW_CRYPTO_BASE | 硬件加密 |
0xD000 | TINY_ERR_MEMPROT_BASE | 存储保护 |
数学错误码 [0x70000]¶
基地址: TINY_ERR_MATH_BASE = 0x70000
TinyMath 运算特有的错误:
| 代码 | 宏 | 触发条件 |
|---|---|---|
0x70001 | TINY_ERR_MATH_INVALID_LENGTH | 数组或向量长度为 0 或超过限制 |
0x70002 | TINY_ERR_MATH_INVALID_PARAM | 参数值超出有效范围 |
0x70003 | TINY_ERR_MATH_PARAM_OUTOFRANGE | 参数超过允许的界限 |
0x70004 | TINY_ERR_MATH_UNINITIALIZED | 模块或数据结构在使用前未初始化 |
0x70005 | TINY_ERR_MATH_REINITIALIZED | 模块或数据结构被初始化多次 |
0x70006 | TINY_ERR_MATH_ARRAY_NOT_ALIGNED | 数组指针未对齐到要求的边界 |
0x70007 | TINY_ERR_MATH_NULL_POINTER | 传入了空指针 |
0x70008 | TINY_ERR_MATH_ZERO_DIVISION | 发生了除零操作 |
0x70009 | TINY_ERR_MATH_NEGATIVE_SQRT | 尝试对负数开平方 |
DSP 错误码 [0x80000]¶
基地址: TINY_ERR_DSP_BASE = 0x80000
TinyDSP 运算特有的错误:
| 代码 | 宏 | 触发条件 |
|---|---|---|
0x80001 | TINY_ERR_DSP_INVALID_LENGTH | 信号或窗口长度为 0 或超过限制 |
0x80002 | TINY_ERR_DSP_INVALID_PARAM | 参数值超出有效范围 |
0x80003 | TINY_ERR_DSP_PARAM_OUTOFRANGE | 参数超过允许的界限 |
0x80004 | TINY_ERR_DSP_UNINITIALIZED | DSP 模块在使用前未初始化 |
0x80005 | TINY_ERR_DSP_REINITIALIZED | DSP 模块被初始化多次 |
0x80006 | TINY_ERR_DSP_ARRAY_NOT_ALIGNED | 缓冲区指针未对齐到要求的边界 |
0x80007 | TINY_ERR_DSP_NULL_POINTER | 传入了空指针 |
0x80008 | TINY_ERR_DSP_ZERO_DIVISION | 发生了除零操作 |
0x80009 | TINY_ERR_DSP_NEGATIVE_SQRT | 尝试对负数开平方 |
0x8000A | TINY_ERR_DSP_MISMATCH | 数据格式或参数不匹配 |
0x8000B | TINY_ERR_DSP_INVALID_MODE | 选择了无效的操作模式 |
0x8000C | TINY_ERR_DSP_MEMORY_ALLOC | DSP 操作期间内存分配失败 |
使用模式¶
#include "tiny_math.h"
tiny_error_t err = tiny_vec_add_f32(a, b, c, len, 1, 1, 1);
if (err != TINY_OK) {
switch (err) {
case TINY_ERR_MATH_NULL_POINTER:
// 处理空指针
break;
case TINY_ERR_MATH_INVALID_LENGTH:
// 处理无效长度
break;
default:
// 通用错误处理
break;
}
}
与 TINY_OK 比较
始终与 TINY_OK(0)比较,而不是用 == false 或 !err。有些错误码有非零值,在布尔语境中可能被误判为真。
源码¶
/**
* @file tiny_error_type.h
* @author SHUAIWEN CUI (SHUAIWEN001@e.ntu.edu.sg)
* @brief The configuration file for the tiny_math middleware.
* @version 1.0
* @date 2025-04-15
* @copyright Copyright (c) 2025
*
*/
#pragma once
#ifdef __cplusplus
extern "C"
{
#endif
/* TYPE DEFINITIONS */
typedef int tiny_error_t; // Error type for the tiny_math middleware
/* MACROS */
/* Definitions for error constants. */
#define TINY_OK 0 /*!< tiny_err_t value indicating success (no error) */
#define TINY_FAIL -1 /*!< Generic tiny_err_t code indicating failure */
#define TINY_ERR_NO_MEM 0x101 /*!< Out of memory */
#define TINY_ERR_INVALID_ARG 0x102 /*!< Invalid argument */
#define TINY_ERR_INVALID_STATE 0x103 /*!< Invalid state */
#define TINY_ERR_INVALID_SIZE 0x104 /*!< Invalid size */
#define TINY_ERR_NOT_FOUND 0x105 /*!< Requested resource not found */
#define TINY_ERR_NOT_SUPPORTED 0x106 /*!< Operation or feature not supported */
#define TINY_ERR_TIMEOUT 0x107 /*!< Operation timed out */
#define TINY_ERR_INVALID_RESPONSE 0x108 /*!< Received response was invalid */
#define TINY_ERR_INVALID_CRC 0x109 /*!< CRC or checksum was invalid */
#define TINY_ERR_INVALID_VERSION 0x10A /*!< Version was invalid */
#define TINY_ERR_INVALID_MAC 0x10B /*!< MAC address was invalid */
#define TINY_ERR_NOT_FINISHED 0x10C /*!< Operation has not fully completed */
#define TINY_ERR_NOT_ALLOWED 0x10D /*!< Operation is not allowed */
#define TINY_ERR_WIFI_BASE 0x3000 /*!< Starting number of WiFi error codes */
#define TINY_ERR_MESH_BASE 0x4000 /*!< Starting number of MESH error codes */
#define TINY_ERR_FLASH_BASE 0x6000 /*!< Starting number of flash error codes */
#define TINY_ERR_HW_CRYPTO_BASE 0xc000 /*!< Starting number of HW cryptography module error codes */
#define TINY_ERR_MEMPROT_BASE 0xd000 /*!< Starting number of Memory Protection API error codes */
#define TINY_ERR_MATH_BASE 0x70000
#define TINY_ERR_MATH_INVALID_LENGTH (TINY_ERR_MATH_BASE + 1)
#define TINY_ERR_MATH_INVALID_PARAM (TINY_ERR_MATH_BASE + 2)
#define TINY_ERR_MATH_PARAM_OUTOFRANGE (TINY_ERR_MATH_BASE + 3)
#define TINY_ERR_MATH_UNINITIALIZED (TINY_ERR_MATH_BASE + 4)
#define TINY_ERR_MATH_REINITIALIZED (TINY_ERR_MATH_BASE + 5)
#define TINY_ERR_MATH_ARRAY_NOT_ALIGNED (TINY_ERR_MATH_BASE + 6)
#define TINY_ERR_MATH_NULL_POINTER (TINY_ERR_MATH_BASE + 7)
#define TINY_ERR_MATH_ZERO_DIVISION (TINY_ERR_MATH_BASE + 8)
#define TINY_ERR_MATH_NEGATIVE_SQRT (TINY_ERR_MATH_BASE + 9)
#define TINY_ERR_DSP_BASE 0x80000
#define TINY_ERR_DSP_INVALID_LENGTH (TINY_ERR_DSP_BASE + 1)
#define TINY_ERR_DSP_INVALID_PARAM (TINY_ERR_DSP_BASE + 2)
#define TINY_ERR_DSP_PARAM_OUTOFRANGE (TINY_ERR_DSP_BASE + 3)
#define TINY_ERR_DSP_UNINITIALIZED (TINY_ERR_DSP_BASE + 4)
#define TINY_ERR_DSP_REINITIALIZED (TINY_ERR_DSP_BASE + 5)
#define TINY_ERR_DSP_ARRAY_NOT_ALIGNED (TINY_ERR_DSP_BASE + 6)
#define TINY_ERR_DSP_NULL_POINTER (TINY_ERR_DSP_BASE + 7)
#define TINY_ERR_DSP_ZERO_DIVISION (TINY_ERR_DSP_BASE + 8)
#define TINY_ERR_DSP_NEGATIVE_SQRT (TINY_ERR_DSP_BASE + 9)
#define TINY_ERR_DSP_MISMATCH (TINY_ERR_DSP_BASE + 10)
#define TINY_ERR_DSP_INVALID_MODE (TINY_ERR_DSP_BASE + 11)
#define TINY_ERR_DSP_MEMORY_ALLOC (TINY_ERR_DSP_BASE + 12)
#ifdef __cplusplus
}
#endif