操作系统(OS)

一个轻量级的操作系统，包含了基本的任务操作、消息机制等等

例程：demo/os

1. 宏定义

1.1. OS_WAIT_FOREVER

超时时间特殊值，阻塞等待（永远等待）

#define OS_WAIT_FOREVER 0xFFFFFFFF

1.2. OS_NO_WAIT

超时时间特殊值，不等待

#define OS_NO_WAIT 0x0

1.3. OS_EVENT_PRI_NORMAL

事件优先级普通,OS_SendEvent的nOption参数的值

#define OS_EVENT_PRI_NORMAL 0

1.4. OS_EVENT_PRI_URGENT

事件优先级紧急，OS_SendEvent的nOption参数的值

#define OS_EVENT_PRI_URGENT 1

1.5. OS_CREATE_DEFAULT

函数OS_CreateTask的nCreationFlags参数的值，表示创建任务后自动开始执行任务

#define OS_CREATE_DEFAULT   0

1.6. OS_CREATE_SUSPENDED

函数OS_CreateTask的nCreationFlags参数的值，表示创建任务后不自动开始执行任务

#define OS_CREATE_SUSPENDED 1

2. 结构体

2.1. OS_Heap_Status_t

堆状态，包括总大小和已经使用了的大小

typedef struct{
    uint32_t usedSize;
    uint32_t totalSize;
}OS_Heap_Status_t;

3. 功能函数

3.1. PTASK_FUNC_T

typedef void (*PTASK_FUNC_T)(PVOID pParameter);
功能

创建的任务主函数，由用户定义

参数
  • pParameter:调用这个函数的时候传入的参数
返回值

无

3.2. OS_SetUserMainHandle

void OS_SetUserMainHandle(HANDLE* appMainHandle);
功能

设置主任务，主任务用来接收来自底层的消息，这个函数必须在开机的时候创建主任务后立即调用，否则可能导致底层无法向应用层发布消息

参数
  • appMainHandle:创建的主任务返回的指针（句柄）
返回值

无

3.3. OS_CreateTask

HANDLE OS_CreateTask(
    PTASK_FUNC_T pTaskEntry,
    PVOID pParameter,
    PVOID pStackAddr,
    UINT16 nStackSize,
    UINT8 nPriority,
    UINT16 nCreationFlags,
    UINT16 nTimeSlice,
    PCSTR pTaskName);
功能

创建一个新的任务

参数
  • pTaskEntry:任务执行函数，PTASK_FUNC_T 类型
  • pParameter:需要传递给执行函数的参数
  • pStackAddr:自定义栈的地址，暂时不支持自定义，即值只能为NULL
  • nStackSize:栈大小
  • nPriority:任务优先级，>=0，每个任务优先级不同，值越小任务优先级越大
  • nCreationFlags: OS_CREATE_DEFAULT/0：默认，创建任务后开始执行任务；OS_CREATE_SUSPENDED：创建任务后不执行任务，需要手动调用start函数开启任务运行
  • nTimeSlice:保留，值为0
  • pTaskName:任务名称
返回值
  • 创建的任务的指针（句柄），如果创建任务失败，则返回NULL

3.4. OS_StartTask

void OS_StartTask(
    HANDLE pHTask,
    PVOID pParameter);
功能

开始执行任务

参数
  • pHTask:任务句柄，OS_CreateTask的返回值
  • pParameter:需要传给任务函数的参数
返回值

无

3.5. OS_StopTask

void OS_StopTask(
    HANDLE pHTask);
功能

停止任务执行

参数
  • pHTask:任务句柄，OS_CreateTask的返回值
返回值

无

3.6. OS_DeleteTask

bool OS_DeleteTask(
    HANDLE hTask);
功能

删除任务

参数
  • hTask:任务句柄，OS_CreateTask的返回值
返回值
  • 删除任务是否成功

3.7. OS_SuspendTask

bool OS_SuspendTask(
    HANDLE hTask);
功能

挂起线程

参数
  • hTask:任务句柄，OS_CreateTask的返回值
返回值
  • 挂起是否成功

3.8. OS_ResumeTask

bool OS_ResumeTask(
    HANDLE hTask);
功能

继续任务

参数
  • hTask:任务句柄，OS_CreateTask的返回值
返回值
  • 是否成功

3.9. OS_Sleep

bool OS_Sleep(UINT32 nMillisecondes);
功能

阻塞毫秒级延时

参数
  • nMillisecondes:阻塞延迟时间，单位毫秒
返回值
  • 是否成功（始终为true）

3.10. OS_SleepUs

void OS_SleepUs(UINT32 us);
功能

阻塞微妙级延时

参数
  • us: 延时时间，单位微妙
返回值

无

3.11. OS_WaitEvent

bool OS_WaitEvent(
    HANDLE   hTask,
    PVOID*   pEvent,
    UINT32   nTimeOut);
功能

阻塞等待事件

参数
  • hTask:任务句柄，OS_CreateTask的返回值
  • pEvent:事件值，来自OS_SendEvent的参数
  • nTimeOut:等待超时时间，目前只支持阻塞等待，即值必须为OS_WAIT_FOREVER
返回值
  • 成功等待到事件

3.12. OS_SendEvent

bool OS_SendEvent(
    HANDLE hTask,
    PVOID  pEvent,
    UINT32 nTimeOut,
    UINT16 nOption);
功能

向某个任务发送事件

参数
  • hTask:任务句柄，OS_CreateTask的返回值
  • pEvent：事件发送的数据（指针）
  • nTimeOut:超时时间，目前只支持阻塞等待，即值必须为OS_WAIT_FOREVER
  • nOption:事件选项，OS_EVENT_PRI_NORMAL：普通优先级，OS_EVENT_PRI_URGENT:紧急优先级
返回值
  • 事件是否发送成功

3.13. OS_ResetEventQueue

bool OS_ResetEventQueue(
    HANDLE hTask);
功能

重置事件队列

参数
  • hTask:任务句柄，OS_CreateTask的返回值
返回值
  • 是否重置成功

3.14. OS_IsEventAvailable

bool OS_IsEventAvailable(
    HANDLE hTask);
功能

判断某个任务是否有事件可以接收

参数
  • hTask:任务句柄，OS_CreateTask的返回值
返回值
  • 是否有事件可以接收

3.15. OS_Malloc

PVOID OS_Malloc (UINT32 nSize);
功能

动态分配内存

参数
  • nSize:动态分配内存长度，单位是字节
返回值
  • 动态分配内存块的首地址，若分配失败，则返回NULL

3.16. OS_Realloc

PVOID OS_Realloc(VOID *ptr, UINT32 nSize);
功能

重新分配内存

参数
  • ptr:动态分配的内存块首地址
  • nSize:新动态分配的内存块长度
返回值
  • 成功分配的内存块首地址，若为NULL，则分配失败

3.17. OS_Free

bool  OS_Free   (PVOID pMemBlock);
功能

释放动态分配的内存

参数
  • pMemBlock:动态分配的内存块首地址
返回值
  • 是否释放成功

3.18. OS_GetHeapUsageStatus

bool OS_GetHeapUsageStatus(OS_Heap_Status_t* pOsHeapStatus);
功能

获取堆的使用情况， 值得注意的是，如果是用OS_Malloc函数分配小的空间后（比如几个字节），使用此函数获得返回的剩余空间大小可能不会减少，而是保持不变。 这是因为内部为减少碎片而做的优化，即预先申请一块空间（331280字节），这块空间用来为以后申请小空间（<1k）使用，如果申请的空间大于1k或者预先申请的空间已经使用完毕，则才会在为申请的空间中申请，这时候用此函数返回的大小才会变化

实际上内部预先分配了331280字节来给未来分配给小空间， 调用OS_Malloc(n)时实际分配如下表，比如OS_Malloc(5)，因为5<10，所以会优先查询簇1，簇1中有250块大小为10字节的预分配空间，如果这250块还有空间没有使用完，则直接返回这里的地址，如果已经使用完了，则继续查找簇2，如此。如果查询完毕簇11仍然没有合适的空间则从新的空间中新分配。这样做是为了防止频繁分配小空间导致内存碎片从而浪费内存空间

簇编号 用户申请字节范围0～m(n<m) 块数量 预分配实际占用的空间
1 10 250 （实际占用了 36*250 字节）
2 24 250 （实际占用了 48*250 字节）
3 28 250 （实际占用了 52*250 字节）
4 32 250 （实际占用了 56*250 字节）
5 52 250 （实际占用了 76*250 字节）
6 100 200 （实际占用了 124*200 字节）
7 156 200 （实际占用了 180*200 字节）
8 200 20 （实际占用了 224*20 字节）
9 528 200 （实际占用了 552*200 字节）
10 700 50 （实际占用了 724*50 字节）
11 1024 50 （实际占用了 1048*50 字节）
参数
  • pOsHeapStatus:堆使用情况
返回值
  • 是否获取堆状态成功

3.19. OS_CreateSemaphore

HANDLE OS_CreateSemaphore(
    UINT32 nInitCount // Specify the initial count of the semaphore
    );
功能

创建一个信号量

参数
  • nInitCount:信号量初始化值，0表示资源被占用，n表示有n个资源值，每次wait将会等待资源值并减一，release操作将会将资源值加一

返回值

  • 信号量句柄，如果失败，返回NULL

3.20. OS_DeleteSemaphore

bool OS_DeleteSemaphore(
    HANDLE hSem);
功能

删除信号量

参数
  • hSem:信号量句柄，OS_CreateSemaphore的返回值
返回值
  • 信号量是否删除成功

3.21. OS_WaitForSemaphore

bool OS_WaitForSemaphore(
    HANDLE hSem,    // Specify the handle to a counting semaphore
    UINT32 nTimeOut // the time-out value
    );
功能

等待信号量知道资源值大于0，并将资源值减一

参数
  • hSem:信号量句柄，OS_CreateSemaphore的返回值
  • nTimeOut:超时值，暂时保留，即值为OS_WAIT_FOREVER
返回值
  • 是否成功获取到信号量（资源值）

3.22. OS_ReleaseSemaphore

bool OS_ReleaseSemaphore(
    HANDLE hSem //Specify the counting semaphore
    );
功能

释放信号量，即资源值加一

参数
  • hSem:信号量句柄，OS_CreateSemaphore的返回值
返回值
  • 是否释放信号量（资源值）成功

3.23. OS_CreateMutex

HANDLE OS_CreateMutex(void);
功能

创建一个互斥量

参数

无

返回值
  • 互斥量句柄，如果失败，返回NULL

3.24. OS_DeleteMutex

void OS_DeleteMutex(HANDLE mutex);
功能

删除互斥量

参数
  • mutex:互斥量句柄，OS_CreateMutex的返回值
返回值

无

3.25. OS_LockMutex

void OS_LockMutex(HANDLE mutex);
功能

锁互斥量，即占用资源

参数
  • mutex:互斥量句柄，OS_CreateMutex的返回值
返回值

无

3.26. OS_UnlockMutex

void OS_UnlockMutex(HANDLE mutex);
功能

释放互斥量，即释放资源

参数
  • mutex:互斥量句柄，OS_CreateMutex的返回值
返回值

无

3.27. OS_CALLBACK_FUNC_T

typedef void (*OS_CALLBACK_FUNC_T)(void* param);
功能

回调函数，由用户定义

参数
  • param：用户传入的参数
返回值

无

3.28. OS_StartCallbackTimer

bool OS_StartCallbackTimer(HANDLE hTask, UINT32 ms, OS_CALLBACK_FUNC_T callback, void* param);
功能

开始软件计时器，设定时间到了后会触发回调函数

参数
  • hTask:任务句柄，这个指定的任务里必须包含OS_WaitEvent函数调用（比如可以传主任务），否则不会触发回调
  • ms：定时时间
  • callback：回调函数
  • param：传入回调函数的参数
返回值
  • 创建定时器是否成功

3.29. OS_StopCallbackTimer

bool OS_StopCallbackTimer(HANDLE hTask, OS_CALLBACK_FUNC_T callback, void *param);
功能

停止软件计时器

参数
  • hTask:任务句柄，这个指定的任务里必须包含OS_WaitEvent函数调用（比如可以传主任务），否则不会触发回调
  • callback：回调函数
  • param：传入回调函数的参数
返回值
  • 停止定时器是否成功

3.30. OS_QueryCallbackTimer

uint32_t OS_QueryCallbackTimer(HANDLE hTask, OS_CALLBACK_FUNC_T callback, void *param);
功能

查询软件计时器还剩多少时间结束

参数
  • hTask:任务句柄，这个指定的任务里必须包含OS_WaitEvent函数调用（比如可以传主任务），否则不会触发回调
  • callback：回调函数
  • param：传入回调函数的参数
返回值
  • 定时器离结束剩余的时间

results matching ""

    No results matching ""