移植案例与原理 - HDF驱动框架-OSAL

news2024/11/17 9:54:06

为了提升驱动代码在不同内核子系统间的可复用能力，OpenHarmony HDF（Hardware Driver Foundation）驱动框架提供了OSAL(Operating System Abstraction Layer)操作系统抽象层接口。OSAL为驱动程序提供了任务、定时器、互斥锁、信号量等基础库相关接口，使驱动相关的实现不再依赖于具体的内核或POSIX接口，是实现驱动可迁移的基石。OpenHarmony HDF驱动框架已经在LiteOS-M，LiteOS-A，Linux内核完成适配，可直接使用。

本文主要分析下驱动适配代码仓中的OSAL的相关接口，主要以适配LiteOS-M内核的OSAL接口为例。OSAL在HDF驱动框架中的位置，见HDF架构图。

1、OSAL头文件

在文件夹drivers/framework/include/osal中定义了OSAL的头文件，对这些头文件的说明如下。

头文件	头文件描述
osal_atomic.h	原子变量相关接口
osal_cdev.h	字符设备相关接口
osal_file.h	文件相关接口
osal_firmware.h	固件文件相关接口
osal_io.h	I/O操作类接口
osal_irq.h	中断相关接口
osal_mem.h	内存申请释放接口
osal_mutex.h	互斥锁相关接口
osal_sem.h	信号量相关接口
osal_spinlock.h	自旋锁相关接口
osal_thread.h	线程相关接口
osal_time.h	时间相关接口
osal_timer.h	定时器相关接口

2、原子变量相关接口

在头文件drivers\framework\include\osal\osal_atomic.h中定义了原子变量相关接口。对于LiteOS-M内核，接口实现程序定义在文件drivers\adapter\khdf\liteos_m\osal\include\osal_atomic_def.h中。

接口	接口描述
OsalAtomicRead(v)	读取原子类型的计数变量值
OsalAtomicSet(v, counter)	设置原子类型的计数变量值
OsalAtomicInc	原子类型的计数变量值加1
OsalAtomicIncReturn	原子类型的计数变量值加1，并返回更新后的值
OsalAtomicDec	原子类型的计数变量值减1
OsalAtomicDecReturn	原子类型的计数变量值减1，并返回更新后的值
OsalTestBit	测试指定变量指定位的值
OsalTestSetBit	设置指定变量指定位的值，并返回设置前的值
OsalTestClearBit	清除指定变量指定位的值，并返回清除前的值
OsalClearBit	清除指定变量指定位的值

3、内存申请释放接口

在头文件drivers\framework\include\osal\osal_mem.h中定义了内存申请释放相关接口。对于LiteOS-M内核，接口实现程序定义在文件drivers\adapter\khdf\liteos_m\osal\src\osal_mem.c中。

接口	接口描述
void *OsalMemAlloc(size_t size)	申请内存接口
void *OsalMemCalloc(uint32_t size)	申请内存接口，并把申请的内存清零
void OsalMemAllocAlign(size_t alignment, size_t size)	申请内存接口，内存地址按照指定大小进行边界对齐
void OsalMemFree(void mem)	释放内存接口

4、互斥锁相关接口

在头文件drivers\framework\include\osal\osal_mutex.h中定义了互斥锁相关接口。对于LiteOS-M内核，接口实现程序定义在文件drivers\adapter\khdf\liteos_m\osal\src\osal_mutex.c中。

接口	接口描述
int32_t OsalMutexInit(struct OsalMutex *mutex)	初始化互斥锁
int32_t OsalMutexDestroy(struct OsalMutex *mutex)	销毁互斥锁
int32_t OsalMutexLock(struct OsalMutex *mutex)	获取互斥锁
int32_t OsalMutexTimedLock(struct OsalMutex *mutex, uint32_t ms)	获取到互斥锁或者超时时返回
int32_t OsalMutexUnlock(struct OsalMutex *mutex)	释放互斥锁

5、自旋锁相关接口

在头文件drivers\framework\include\osal\osal_spinlock.h中定义了自旋锁相关接口。对于LiteOS-M内核，接口实现程序定义在文件drivers\adapter\khdf\liteos_m\osal\src\osal_spinlock.c中。

接口	接口描述
int32_t OsalSpinInit(OsalSpinlock *spinlock)	初始化自旋锁
int32_t OsalSpinDestroy(OsalSpinlock *spinlock)	销毁自旋锁
int32_t OsalSpinLock(OsalSpinlock *spinlock)	获取自旋锁
int32_t OsalSpinUnlock(OsalSpinlock *spinlock)	释放自旋锁
int32_t OsalSpinLockIrq(OsalSpinlock *spinlock)	获取自旋锁接口，并且去使能中断
int32_t OsalSpinUnlockIrq(OsalSpinlock *spinlock)	释放自旋锁接口，并且使能中断
int32_t OsalSpinLockIrqSave(OsalSpinlock spinlock, uint32_t flags)	获取自旋锁接口，并且去使能中断，保存中断状态
int32_t OsalSpinUnlockIrqRestore(OsalSpinlock spinlock, uint32_t flags)	释放自旋锁接口，并且使能中断，恢复保存的中断状态

6、信号量相关接口

在头文件drivers\framework\include\osal\osal_sem.h中定义了信号量相关接口。对于LiteOS-M内核，接口实现程序定义在文件drivers\adapter\khdf\liteos_m\osal\src\osal_sem.c中。

接口	接口描述
int32_t OsalSemInit(struct OsalSem *sem, uint32_t value)	初始化信号量
int32_t OsalSemWait(struct OsalSem *sem, uint32_t ms)	等待信号量
int32_t OsalSemPost(struct OsalSem *sem)	释放信号量
int32_t OsalSemDestroy(struct OsalSem *sem)	销毁信号量

7、线程相关接口

在头文件drivers\framework\include\osal\osal_thread.h中定义了信号量相关接口。对于LiteOS-M内核，接口实现程序定义在文件drivers\adapter\khdf\liteos_m\osal\src\osal_thread.c中。

接口	接口描述
int32_t OsalThreadCreate(struct OsalThread thread, OsalThreadEntry threadEntry, void entryPara)	创建线程
int32_t OsalThreadBind(struct OsalThread *thread, unsigned int cpuID)	绑定线程到指定的CPU上运行
int32_t OsalThreadStart(struct OsalThread thread, const struct OsalThreadParam param)	启动线程
int32_t OsalThreadDestroy(struct OsalThread *thread)	销毁线程