os_applAPI.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012 Peter Eckstrand
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted (subject to the limitations in the
 * disclaimer below) provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
 * GRANTED BY THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This file is part of the cocoOS operating system.
 * Author: Peter Eckstrand <info@cocoos.net>
 */
 

#ifndef _os_applapi_h__
#define _os_applapi_h__

#include "cocoos.h"

#ifdef __cplusplus
extern "C" {
#endif


/*********************************************************************************/
/*  task_open()                                                 */
#define task_open()                 OS_BEGIN


/*********************************************************************************/
/*  task_close()                                                 */
#define task_close()                OS_END


/*********************************************************************************/
/*  task_wait(x)                                                 */
#define task_wait(x)                OS_WAIT_TICKS(x,0)


/*********************************************************************************/
/*  task_wait_id(id,x)                                                 */
#define task_wait_id(id,x)                OS_WAIT_TICKS(x,id)


/*********************************************************************************/
/*  task_suspend( id )                                                 */
#define task_suspend( id )    OS_SUSPEND_TASK( id )


 /*********************************************************************************/
/*  task_resume(id)                                                 */
#define task_resume( id )     OS_RESUME_TASK( id )


/*********************************************************************************/
/*  event_wait(event)                                                 */
#define event_wait(event)    OS_WAIT_SINGLE_EVENT(event,0)


/*********************************************************************************/
/*  event_wait_timeout(event,timeout)                                                 */
#define event_wait_timeout(event,timeout)    OS_WAIT_SINGLE_EVENT(event,timeout)

/*********************************************************************************/
/*  event_get_timeout()                                                 */
#define event_get_timeout()                   OS_GET_TASK_TIMEOUT_VALUE()

/*********************************************************************************/
/*  event_wait_multiple(waitAll, args...)                                                 */
#define event_wait_multiple(waitAll, args...)   OS_WAIT_MULTIPLE_EVENTS( waitAll, args)


/*********************************************************************************/
/*  event_signal(event)                                                 */
#define event_signal(event) OS_SIGNAL_EVENT(event)


/*********************************************************************************/
/*  event_ISR_signal(event)                                                 */
#define event_ISR_signal(event) OS_INT_SIGNAL_EVENT(event)


/*********************************************************************************/
/*  sem_wait(sem)                                                 */
#define sem_wait(sem)  OS_WAIT_SEM(sem)


/*********************************************************************************/
/*  sem_signal(sem)                                                 */
#define sem_signal(sem)     OS_SIGNAL_SEM(sem)


/*********************************************************************************/
/*  sem_ISR_signal(sem)                                                 */
#define sem_ISR_signal(sem)     OS_SIGNAL_SEM_NO_SCHEDULE(sem)


/*********************************************************************************/
/*  msg_post(task_id, msg)                                            */
/*********************************************************************************/
#define msg_post(task_id, msg)   OS_MSG_Q_POST(task_id, msg, 0, 0, 0)


/*********************************************************************************/
/*  msg_post_async(task_id, msg)                                            */
/*********************************************************************************/
#define msg_post_async(task_id, msg)   OS_MSG_Q_POST(task_id, msg, 0, 0, 1)


/*********************************************************************************/
/*  msg_post_in(task_id, msg, delay)                                            */
/*********************************************************************************/
#define msg_post_in(task_id, msg, delay)   OS_MSG_Q_POST(task_id, msg, delay, 0, 0)


/*********************************************************************************/
/*  msg_post_every(task_id, msg, period)                                            */
/*********************************************************************************/
#define msg_post_every(task_id, msg, period)   OS_MSG_Q_POST(task_id, msg, period, period, 0)


/*********************************************************************************/
/*  msg_receive( task_id, pMsg )                                            */
/*********************************************************************************/
#define msg_receive( task_id, pMsg )        OS_MSG_Q_RECEIVE( task_id, pMsg, 0 )


/*********************************************************************************/
/*  msg_receive_async( task_id, pMsg )                                            */
/*********************************************************************************/
#define msg_receive_async( task_id, pMsg )        OS_MSG_Q_RECEIVE( task_id, pMsg, 1 )



void os_init( void );
void os_start( void );
void os_tick( void );
void os_sub_tick( uint8_t id );
void os_sub_nTick( uint8_t id, uint16_t nTicks );
uint8_t os_get_running_tid(void);

uint8_t task_create( taskproctype taskproc, void *data, uint8_t prio, Msg_t* msgPool, uint8_t poolSize, uint16_t msgSize );
void task_kill( uint8_t tid );
void *task_get_data();
Sem_t sem_bin_create( uint8_t initial );
Sem_t sem_counting_create( uint8_t max, uint8_t initial );

Evt_t event_create( void );
uint8_t event_signaling_taskId_get( Evt_t ev );
TaskState_t task_state_get(uint8_t tid);
void os_cbkSleep( void );

#ifdef __cplusplus
}
#endif

#endif