INT32U OSTimeGet (void);
所属文件 OS_TIMC.C
OSTimeGet()获取当前系统时钟数值。系统时钟是一个32位的计数器,记录系统上电后或时钟重新设置后的时钟计数。
返回值
当前时钟计数(时钟节拍数)。
void OSTimeSet (INT32U ticks);
所属文件 OS_TIMC.C
OSTimeSet()设置当前系统时钟数值。系统时钟是一个32位的计数器,记录系统上电后或时钟重新设置后的时钟计数。
参数
ticks要设置的时钟数,单位是时钟节拍数。
void OSTimeTick (void);
所属文件 OS_TIMC.C
每次时钟节拍,μC/OS-II 都将执行OSTimeTick()函数。OSTimeTick()检查处于延时状态的任务是否达到延时时间(用OSTimeDly()或OSTimeDlyHMSM()函数延时),或正在等待事件的任务是否超时。
注意/警告
OSTimeTick()的运行时间和系统中的任务数直接相关,在任务或中断中都可以调用。如果在任务中调用,任务的优先级应该很高(优先级数字很小),这是因为OSTimeTick()负责所有任务的延时操作。
INT16U OSVersion (void);
所属文件 OS_CORE.C
OSVersion()获取当前μC/OS-II的版本。
返回值
当前版本,格式为x.yy,返回值为乘以100后的数值。例如当前版本2.00,则返回200。
void OS_ENTER_CRITICAL(void);
void OS_EXIT_CRITICAL(void);
所属文件 OS_CPU.C
OS_ENTER_CRITICAL()和OS_EXIT_CRITICAL()为定义的宏,用来关闭、打开CPU的中断。
注意/警告
OS_ENTER_CRITICAL()和OS_EXIT_CRITICAL()必须成对使用。
OS_MEM *OSMemCreate(void *addr,INT32U nblks,INT32U blksize,INT8U *err);
所属文件 OS_MEM.C
OSMemCreate()函数建立并初始化一块内存区。一块内存区包含指定数目的大小确定的内存块。程序可以包含这些内存块并在用完后释放回内存区。
参数
addr
Nblks
Blksize 每个内存块的大小,最少应该能够容纳一个指针。
Err
OS_NO_ERR :成功建立内存区。
OS_MEM_INVALID_PART :没有空闲的内存区。
OS_MEM_INVALID_BLKS :没有为每一个内存区建立至少两个内存块。
OS_MEM_INVALID_SIZE :内存块大小不足以容纳一个指针变量。
返回值
OSMemCreate()函数返回指向内存区控制块的指针。如果没有剩余内存区,OSMemCreate()函数返回空指针。
注意/警告:必须首先建立内存区,然后使用。
Void *OSMemGet(OS_MEM *pmem,INT8U *err);
所属文件 OS_MEM.C
OSMemGet()函数用于从内存区分配一个内存块。用户程序必须知道所建立的内存块的大小,同时用户程序必须在使用完内存块后释放内存块。可以多次调用OSMemGet()函数。
参数
pmem 是指向内存区控制块的指针,可以从OSMemCreate()函数返回得到。
Err
OS_NO_ERR :成功得到一个内存块。
OS_MEM_NO_FREE_BLKS :内存区已经没有空间分配给内存块。
返回值
OSMemGet()函数返回指向内存区块的指针。如果没有空间分配给内存块,OSMemGet()函数返回空指针。
注意/警告:必须首先建立内存区,然后使用。
INT8U OSMemPut(OS_MEM *pmem, void *pblk);
所属文件 OS_MEM.C
OSMemPut()函数释放一个内存块,内存块必须释放回原先申请的内存区。
参数
pmem 是指向内存区控制块的指针,可以从OSMemCreate()函数 返回得到。
Pblk 是指向将被释放的内存块的指针。
返回值
OSMemPut()函数的返回值为下述之一:
OS_NO_ERR :成功释放内存块
OS_MEM_FULL :内存区已经不能再接受更多释放的内存块。这种情况说明用户程序出现了错误,释放了多于用OSMemGet()函数得到的内存块。
注意/警告:必须首先建立内存区,然后使用。
内存块必须释放回原先申请的内存区。
INT8U OSMemQuery(OS_MEM *pmem, OS_MEM_DATA *pdata);
所属文件 OS_MEM.C
OSMemQuery()函数得到内存区的信息。该函数返回OS_MEM结构包含的信息,但使用了一个新的OS_MEM_DATA的数据结构。OS_MEM_DATA数据结构还包含了正被使用的内存块数目的域。
参数
pmem 是指向内存区控制块的指针,可以从OSMemCreate()函数 返回得到。
Pdata
Void
Void
INT32U
INT32U
INT32U
INT32U
返回值
OSMemQuery()函数返回值总是OS_NO_ERR。
注意/警告:必须首先建立内存区,然后使用。
Void *OSMboxAccept(OS_EVENT *pevent);
所属文件 OS_MBOX.C
参数:pevent 是指向需要查看的消息邮箱的指针。当建立消息邮箱时,该指针返回到用户程序。
返回值:如果消息已经到达,返回指向该消息的指针;如果消息邮箱没有消息,返回空指针。
注意/警告:必须先建立消息邮箱,然后使用。
OS_EVENT *OSMboxCreate(void *msg);
所属文件 OS_MBOX.C
OSMboxCreate()建立并初始化一个消息邮箱。消息邮箱允许任务或中断向其他一个或几个任务发送消息。
参数
msg 参数用来初始化建立的消息邮箱。如果该指针不为空,建立的消息邮箱将含有消息。
返回值
指向分配给所建立的消息邮箱的事件控制块的指针。如果没有可用的事件控制块,返回空指针。
注意/警告:必须先建立消息邮箱,然后使用。
OSMboxPend(OS_EVENT *pevent,INT16U timeout,int8u *err);
所属文件 OS_MBOX.C
OSMboxPend()用于任务等待消息。消息通过中断或另外的任务发送给需要的任务。消息是一个以指针定义的变量,在不同的程序中消息的使用也可能不同。如果调用OSMboxPend()函数时消息邮箱已经存在需要的消息,那么该消息被返回给OSMboxPend()的调用者,消息邮箱中清除该消息。如果调用OSMboxPend()函数时消息邮箱中没有需要的消息,OSMboxPend()函数挂起当前任务直到得到需要的消息或超出定义等待超时的时间。如果同时有多个任务等待同一个消息,μC/OS-Ⅱ默认最高优先级的任务取得消息并且任务恢复执行。一个由OSTaskSuspend()函数挂起的任务也可以接受消息,但这个任务将一直保持挂起状态直到通过调用OSTaskResume()函数恢复任务的运行。
参数
pevent
Timeout
Err 是指向包含错误码的变量的指针。OSMboxPend()函数返回的错误码可能为下述几种:OS_NO_ERR :消息被正确的接受。
OS_TIMEOUT :消息没有在指定的周期数内送到。
OS_ERR_PEND_ISR :从中断调用该函数。虽然规定了不允许从中断调用该函数,但μC/OS-Ⅱ仍然包含了检测这种情况的功能。
OS_ERR_EVENT_TYPE
返回值
OSMboxPend()函数返回接受的消息并将 *err置为OS_NO_ERR。如果没有在指定数目的时钟节拍内接受到需要的消息,OSMboxPend()函数返回空指针并且将 *err设置为OS_TIMEOUT。
注意/警告:必须先建立消息邮箱,然后使用。不允许从中断调用该函数。
INT8U OSMboxPost(OS_EVENT *pevent, void *msg);
所属文件 OS_MBOX.C
OSMboxPost()函数通过消息邮箱向任务发送消息。消息是一个指针长度的变量,在不同的程序中消息的使用也可能不同。如果消息邮箱中已经存在消息,返回错误码说明消息邮箱已满。OSMboxPost()函数立即返回调用者,消息也没有能够发到消息邮箱。如果有任何任务在等待消息邮箱的消息,最高优先级的任务将得到这个消息。如果等待消息的任务优先级比发送消息的任务优先级高,那么高优先级的任务将得到消息而恢复执行,也就是说,发生了一次任务切换。
参数
pevent
Msg 是即将实际发送给任务的消息。消息是一个指针长度的变量,在不同的程序中消息的使用也可能不同。不允许传递一个空指针,因为这意味着消息邮箱为空。
返回值
OSMboxPost()函数的返回值为下述之一:
OS_NO_ERR :消息成功的放到消息邮箱中。
OS_MBOX_FULL :消息邮箱已经包含了其他消息,不空。
OS_ERR_EVENT_TYPE
注意/警告:必须先建立消息邮箱,然后使用。
不允许传递一个空指针,因为这意味着消息邮箱为空。
INT8U OSMboxQuery(OS_EVENT *pevent, OS_MBOX_DATA *pdata);
所属文件 OS_MBOX.C
OSMboxQuery()函数用来取得消息邮箱的信息。用户程序必须分配一个OS_MBOX_DATA的数据结构,该结构用来从消息邮箱的事件控制块接受数据。通过调用OSMboxQuery()函数可以知道任务是否在等待消息以及有多少个任务在等待消息,还可以检查消息邮箱现在的消息。
参数
pevent
Pdata
Void
INT8U
INT8U OSEventGrp;
返回值
OSMboxQuery()函数的返回值为下述之一:
OS_NO_ERR :调用成功
OS_ERR_EVENT_TYPE
注意/警告:必须先建立消息邮箱,然后使用。
Void
所属文件 OS_Q.C
OSQAccept()函数检查消息队列中是否已经有需要的消息。不同于OSQPend()函数,如果没有需要的消息,OSQAccept()函数并不挂起任务。如果消息已经到达,该消息被传递到用户任务。通常中断调用该函数,因为中断不允许挂起等待消息。
参数
pevent 是指向需要查看的消息队列的指针。当建立消息队列时,该指针返回到用户程序。
返回值
如果消息已经到达,返回指向该消息的指针;如果消息队列没有消息,返回空指针。
注意/警告:必须先建立消息队列,然后使用。
OS_EVENT
所属文件 OS_Q.C
OSQCreate()函数建立一个消息队列。任务或中断可以通过消息队列向其他一个或多个任务发送消息。消息的含义是和具体的应用密切相关的。
参数
start
Size
返回值
OSQCreate()函数返回一个指向消息队列事件控制块的指针。如果没有空余的事件空闲块,OSQCreate()函数返回空指针。
注意/警告:必须先建立消息队列,然后使用。
INT8U *SOQFlush(OS_EVENT *pevent);
所属文件 OS_Q.C
OSQFlush()函数清空消息队列并且忽略发送往队列的所有消息。不管队列中是否有消息,这个函数的执行时间都是相同的。
参数
pevent
返回值
OSQFlush()函数的返回值为下述之一:
OS_NO_ERR :消息队列被成功清空
OS_ERR_EVENT_TYPE :试图清除不是消息队列的对象
注意/警告:必须先建立消息队列,然后使用。
Void *OSQPend( OS_EVENT *pevent, INT16U timeout, INT8U *err);
所属文件 OS_Q.C
OSQPend()函数用于任务等待消息。消息通过中断或另外的任务发送给需要的任务。消息是一个以指针定义的变量,在不同的程序中消息的使用也可能不同。如果调用OSQPend()函数时队列中已经存在需要的消息,那么该消息被返回给OSQPend()函数的调用者,队列中清除该消息。如果调用OSQPend()函数时队列中没有需要的消息,OSQPend()函数挂起当前任务直到得到需要的消息或超出定义的超时时间。如果同时有多个任务等待同一个消息,μC/OS-Ⅱ默认最高优先级的任务取得消息并且任务恢复执行。一个由OSTaskSuspend()函数挂起的任务也可以接受消息,但这个任务将一直保持挂起状态直到通过调用OSTaskResume()函数恢复任务的运行。
参数
pevent
Timeout
Err 是指向包含错误码的变量的指针。OSQPend()函数返回的错误码可能为下述几种:
OS_NO_ERR :消息被正确的接受。
OS_TIMEOUT :消息没有在指定的周期数内送到。
OS_ERR_PEND_ISR :从中断调用该函数。虽然规定了不允许从中断调用该函数,但μC/OS-Ⅱ仍然包含了检测这种情况的功能。
OS_ERR_EVENT_TYPE
返回值
OSQPend()函数返回接受的消息并将 *err置为OS_NO_ERR。如果没有在指定数目的时钟节拍内接受到需要的消息,OSQPend()函数返回空指针并且将 *err设置为OS_TIMEOUT。
注意/警告:必须先建立消息邮箱,然后使用。
不允许从中断调用该函数。
INT8U OSQPost(OS_EVENT *pevent, void *msg);
所属文件 OS_Q.C
OSQPost()函数通过消息队列向任务发送消息。消息是一个指针长度的变量,在不同的程序中消息的使用也可能不同。如果队列中已经存满消息,返回错误码。OSQPost()函数立即返回调用者,消息也没有能够发到队列。如果有任何任务在等待队列中的消息,最高优先级的任务将得到这个消息。如果等待消息的任务优先级比发送消息的任务优先级高,那么高优先级的任务将得到消息而恢复执行,也就是说,发生了一次任务切换。消息队列是先入先出(FIFO)机制的,先进入队列的消息先被传递给任务。
参数
pevent
Msg 是即将实际发送给任务的消息。消息是一个指针长度的变量,在不同的程序中消息的使用也可能不同。不允许传递一个空指针。
返回值
OSQPost()函数的返回值为下述之一:
OS_NO_ERR :消息成功的放到消息队列中。
OS_MBOX_FULL :消息队列已满。
OS_ERR_EVENT_TYPE
注意/警告:必须先建立消息队列,然后使用。
不允许传递一个空指针。
INT8U OSQPostFront(OS_EVENT *pevent, void *msg);
所属文件 OS_Q.C
OSQPostFront()函数通过消息队列向任务发送消息。OSQPostFront()函数和OSQPost()函数非常相似,不同之处在于OSQPostFront()函数将发送的消息插到消息队列的最前端。也就是说,OSQPostFront()函数使得消息队列按照后入先出(LIFO)的方式工作,而不是先入先出(FIFO)。消息是一个指针长度的变量,在不同的程序中消息的使用也可能不同。如果队列中已经存满消息,返回错误码。OSQPost()函数立即返回调用者,消息也没能发到队列。如果有任何任务在等待队列中的消息,最高优先级的任务将得到这个消息。如果等待消息的任务优先级比发送消息的任务优先级高,那么高优先级的任务将得到消息而恢复执行,也就是说,发生了一次任务切换
参数
pevent
Msg 是即将实际发送给任务的消息。消息是一个指针长度的变量,在不同的程序中消息的使用也可能不同。不允许传递一个空指针。
返回值
OSQPost()函数的返回值为下述之一:
OS_NO_ERR :消息成功的放到消息队列中。
OS_MBOX_FULL :消息队列已满。
OS_ERR_EVENT_TYPE
注意/警告:必须先建立消息队列,然后使用。
不允许传递一个空指针。
INT8U OSQQuery(OS_EVENT *pevent, OS_Q_DATA *pdata);
所属文件 OS_Q.C
OSQQuery()函数用来取得消息队列的信息。用户程序必须建立一个OS_Q_DATA的数据结构,该结构用来保存从消息队列的事件控制块得到的数据。通过调用OSQQuery()函数可以知道任务是否在等待消息、有多少个任务在等待消息、队列中有多少消息以及消息队列可以容纳的消息数。OSQQuery()函数还可以得到即将被传递给任务的消息的信息。
参数
pevent
Pdata
Void
INT16U
INT16U
INT8U
INT8U
返回值
OSQQuery()函数的返回值为下述之一:
OS_NO_ERR :调用成功
OS_ERR_EVENT_TYPE
注意/警告:必须先建立消息队列,然后使用。
INT16U *OSSemAccept(OS_EVENT *pevent);
所属文件 OS_SEM.C
OSSemAccept()函数查看设备是否就绪或事件是否发生。不同于OSSemPend()函数,如果设备没有就绪,OSSemAccept()函数并不挂起任务。中断调用该函数来查询信号量。
参数
pevent 是指向需要查询的设备的信号量。当建立信号量时,该指针返回到用户程序。
返回值
当调用OSSemAccept()函数时,设备信号量的值大于零,说明设备就绪,这个值被返回调用者,设备信号量的值减一。如果调用OSSemAccept()函数时,设备信号量的值等于零,说明设备没有就绪,返回零。
注意/警告:必须先建立信号量,然后使用。
OS_EVENT *OSSemCreate(WORD value);
所属文件 OS_SEM.C
OSSemCreate()函数建立并初始化一个信号量。信号量的作用如下:
允许一个任务和其他任务或者中断同步。
取得设备的使用权标志事件的发生
参数
value 参数是建立的信号量的初始值,可以取0到65535之间的任何值。
返回值
OSSemCreate()函数返回指向分配给所建立的消息邮箱的事件控制块的指针。如果没有可用的事件控制块,OSSemCreate()函数返回空指针。
注意/警告:必须先建立信号量,然后使用。
Void OSSemPend ( OS_EVNNT
所属文件 OS_SEM.C
OSSemPend()函数用于任务试图取得设备的使用权,任务需要和其他任务或中断同步,任务需要等待特定事件的发生的场合。如果任务调用OSSemPend()函数时,信号量的值大于零,OSSemPend()函数递减该值并返回该值。如果调用时信号量等于零,OSSemPend()函数函数将任务加入该信号量的等待队列。OSSemPend()函数挂起当前任务直到其他的任务或中断置起信号量或超出等待的预期时间。如果在预期的时钟节拍内信号量被置起,μC/OS-Ⅱ默认最高优先级的任务取得信号量恢复执行。一个被OSTaskSuspend()函数挂起的任务也可以接受信号量,但这个任务将一直保持挂起状态直到通过调用OSTaskResume()函数恢复任务的运行。
参数
pevent
Timeout
Err 是指向包含错误码的变量的指针。OSSemPend()函数返回的错误码可能为下述几种:
OS_NO_ERR :信号量不为零。
OS_TIMEOUT :信号量没有在指定的周期数内置起。
OS_ERR_PEND_ISR :从中断调用该函数。虽然规定了不允许从中断调用该函数,但μC/OS-Ⅱ仍然包含了检测这种情况的功能。
OS_ERR_EVENT_TYPE
注意/警告:必须先建立信号量,然后使用。
不允许从中断调用该函数。
INT8U OSSemPost(OS_EVENT *pevent);
所属文件 OS_SEM.C
OSSemPost()函数置起指定的信号量。如果指定的信号量是零或大于零,OSSemPost()函数递增该信号量并返回。如果有任何任务在等待信号量,最高优先级的任务将得到信号量并进入就绪状态。任务调度函数将进行任务调度,决定当前运行的任务是否仍然为最高优先级的就绪状态的任务。
参数
pevent
返回值
OSSemPost()函数的返回值为下述之一:
OS_NO_ERR :信号量成功的置起
OS_SEM_OVF :信号量的值溢出
OS_ERR_EVENT_TYPE
注意/警告:必须先建立信号量,然后使用。
INT8U OSSemQuery(OS_EVENT *pevent, OS_SEM_DATA *pdata);
所属文件 OS_SEM.C
OSSemQuery()函数用于获取某个信号量的信息。使用OSSemQuery()之前,应用程序需要先创立类型为OS_SEM_DATA的数据结构,用来保存从信号量的事件控制块中取得的数据。使用OSSemQuery()可以得知是否有,以及有多少任务位于信号量的任务等待队列中(通过查询.OSEventTbl [ ]域),还可以获取信号量的标识号码。OSEventTbl [ ]域的大小由语句:
#define constant OS_ENENT_TBL_ SIZE定义(参阅文件uCOS_II.H)。
参数
pevent是一个指向信号量的指针。该指针在信号量建立后返回调用程序[参见OSSemCreat()函数]。
Pdata是一个指向数据结构OS_SEM_DATA的指针,该数据结构包含下述域:
INT16U OSCnt;
INT8U
INT8U
返回值
OSSemQuery()函数有下述两个返回值:
OS_NO_ERR 表示调用成功。
OS_ERR_EVENT_TYPE 表示未向信号量传递指针。
注意/警告:被操作的信号量必须是已经建立了的。