UCOS-II-API-参考手册
参考手册UCOS-II API 参考手册本章提供了C/OS-的用户指南。每一个用户可以调用的内核函数都按字母顺序加以说明，包括：l 函数的功能描述l 函数原型l 函数名称及源代码l 函数使用到的常量l 函数参数l 函数返回值l 特殊说明和注意点OSInit( )Void OSInit(void);所属文件调用者开关量OS_CORE.C启动代码无OSinit（）初始化C/OS-，对这个函数的调用必须在调用OSStart（）函数之前，而OSStart（）函数真正开始运行多任务。参数无返回值无注意/警告必须先于OSStart（）函数的调用范例：void main (void) . OSInit(); /* 初始化 uC/OS-II */ . OSStart(); /*启动多任务内核 */OSIntEnter( )Void OSIntEnter（void）;所属文件调用者开关量OS_CORE.C中断无OSIntEnter（）通知C/OS-一个中断处理函数正在执行，这有助于C/OS-掌握中断嵌套的情况。OSIntEnter（）函数通常和OSIntExit（）函数联合使用。参数无返回值无注意/警告在任务级不能调用该函数。如果系统使用的处理器能够执行自动的独立执行读取-修改-写入的操作，那么就可以直接递增中断嵌套层数（OSIntNesting），这样可以避免调用函数所带来的额外的开销。范例一：（Intel 80x86的实模式, 在大模式下编译，real mode，large model） ISRx PROC FAR PUSHA ; 保存中断现场 PUSH ES PUSH DS; MOV AX, DGROUP ; 读入数据段 MOV DS, AX; CALL FAR PTR _OSIntEnter ; 通知内核进入中断 . . POP DS ; 恢复中断现场 POP ES POPA IRET ; 中断返回 ISRx ENDP范例二：（Intel 80x86的实模式, 在大模式下编译，, real mode , large model） ISRx PROC FAR PUSHA ; 保存中断现场 PUSH ES PUSH DS; MOV AX, DGROUP ; 读入数据段 MOV DS, AX; INC BYTE PTR _OSIntNesting ; 通知内核进入中断 . . . POP DS ; 恢复中断现场 POP ES POPA IRET ; 中断返回 ISRx ENDPOSIntExit( )Void OSIntExit（void）;所属文件调用者开关量OS_CORE.C中断无OSIntExit（）通知C/OS-一个中断服务已执行完毕，这有助于C/OS-掌握中断嵌套的情况。通常OSIntExit（）和OSIntEnter（）联合使用。当最后一层嵌套的中断执行完毕后，如果有更高优先级的任务准备就绪，C/OS-会调用任务调度函数，在这种情况下，中断返回到更高优先级的任务而不是被中断了的任务。参数无返回值无注意/警告在任务级不能调用该函数。并且即使没有调用OSIntEnter（）而是使用直接递增OSIntNesting的方法，也必须调用OSIntExit（）函数。范例：（Intel 80x86 的实模式, 在大模式下编译， real mode , large model） ISRx PROC FAR PUSHA ; 保存中断现场 PUSH ES PUSH DS . . CALL FAR PTR _OSIntExit ; 通知内核进入中断 POP DS ; 恢复中断现场 POP ES POPA IRET ; 中断返回 ISRx ENDPOSMboxAccept( )Void *OSMboxAccept（OS_EVENT *pevent）;所属文件调用者开关量OS_MBOX.C任务或中断OS_MBOX_ENOSMboxAccept（）函数查看指定的消息邮箱是否有需要的消息。不同于OSMboxPend（）函数，如果没有需要的消息，OSMboxAccept（）函数并不挂起任务。如果消息已经到达，该消息被传递到用户任务并且从消息邮箱中清除。通常中断调用该函数，因为中断不允许挂起等待消息。参数pevent 是指向需要查看的消息邮箱的指针。当建立消息邮箱时，该指针返回到用户程序。（参考OSMboxCreate（）函数）。返回值如果消息已经到达，返回指向该消息的指针；如果消息邮箱没有消息，返回空指针。注意/警告必须先建立消息邮箱，然后使用。范例：OS_EVENT *CommMbox;void Task (void *pdata) void *msg; pdata = pdata; for (;) msg = OSMboxAccept(CommMbox); /* 检查消息邮箱是否有消息*/ if (msg != (void *)0) . /* 处理消息*/ . else . /*没有消息*/ . . . OSMboxCreate( )OS_EVENT *OSMboxCreate（void *msg）;所属文件调用者开关量OS_MBOX.C任务或启动代码OS_MBOX_ENOSMboxCreate（）建立并初始化一个消息邮箱。消息邮箱允许任务或中断向其他一个或几个任务发送消息。参数msg 参数用来初始化建立的消息邮箱。如果该指针不为空，建立的消息邮箱将含有消息。返回值指向分配给所建立的消息邮箱的事件控制块的指针。如果没有可用的事件控制块，返回空指针。注意/警告必须先建立消息邮箱，然后使用。范例：OS_EVENT *CommMbox; void main(void) . . OSInit(); /* 初始化C/OS- */ . . CommMbox = OSMboxCreate(void *)0); /* 建立消息邮箱 */ OSStart(); /* 启动多任务内核 */OSMboxPend( )Void *OSMboxPend ( OS_EVNNT *pevent, INT16U timeout, int8u *err );所属文件调用者开关量OS_MBOX.C任务OS_MBOX_ENOSMboxPend（）用于任务等待消息。消息通过中断或另外的任务发送给需要的任务。消息是一个以指针定义的变量，在不同的程序中消息的使用也可能不同。如果调用OSMboxPend（）函数时消息邮箱已经存在需要的消息，那么该消息被返回给OSMboxPend（）的调用者，消息邮箱中清除该消息。如果调用OSMboxPend（）函数时消息邮箱中没有需要的消息，OSMboxPend（）函数挂起当前任务直到得到需要的消息或超出定义等待超时的时间。如果同时有多个任务等待同一个消息，C/OS-默认最高优先级的任务取得消息并且任务恢复执行。一个由OSTaskSuspend（）函数挂起的任务也可以接受消息，但这个任务将一直保持挂起状态直到通过调用OSTaskResume（）函数恢复任务的运行。参数pevent 是指向即将接受消息的消息邮箱的指针。该指针的值在建立该消息邮箱时可以得到。（参考OSMboxCreate（）函数）。Timeout 允许一个任务在经过了指定数目的时钟节拍后还没有得到需要的消息时恢复运行。如果该值为零表示任务将持续的等待消息。最大的等待时间为65,535个时钟节拍。这个时间长度并不是非常严格的，可能存在一个时钟节拍的误差，因为只有在一个时钟节拍结束后才会减少定义的等待超时时钟节拍。Err 是指向包含错误码的变量的指针。OSMboxPend（）函数返回的错误码可能为下述几种：l OS_NO_ERR ：消息被正确的接受。l OS_TIMEOUT ：消息没有在指定的周期数内送到。l OS_ERR_PEND_ISR ：从中断调用该函数。虽然规定了不允许从中断调用该函数，但C/OS-仍然包含了检测这种情况的功能。l OS_ERR_EVENT_TYPE ：pevent 不是指向消息邮箱的指针。返回值OSMboxPend（）函数返回接受的消息并将 *err置为OS_NO_ERR。如果没有在指定数目的时钟节拍内接受到需要的消息，OSMboxPend（）函数返回空指针并且将 *err设置为OS_TIMEOUT。注意/警告必须先建立消息邮箱，然后使用。不允许从中断调用该函数。范例：OS_EVENT *C
