mirror of
https://github.com/kelvinlawson/atomthreads.git
synced 2026-03-06 12:33:13 +01:00
Add Atomthreads RTOS source files.
This commit is contained in:
119
kernel/atom.h
Executable file
119
kernel/atom.h
Executable file
@@ -0,0 +1,119 @@
|
||||
/*
|
||||
* Copyright (c) 2010, Kelvin Lawson. All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted 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.
|
||||
* 3. No personal names or organizations' names associated with the
|
||||
* Atomthreads project may be used to endorse or promote products
|
||||
* derived from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE ATOMTHREADS PROJECT 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 PROJECT 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.
|
||||
*/
|
||||
|
||||
#ifndef __ATOM_H
|
||||
#define __ATOM_H
|
||||
|
||||
#include "atomtimer.h"
|
||||
#include "atomuser.h"
|
||||
|
||||
/* Data types */
|
||||
|
||||
/* Forward declaration */
|
||||
struct atom_tcb;
|
||||
|
||||
typedef struct atom_tcb
|
||||
{
|
||||
/* Thread's current stack pointer. When a thread is scheduled
|
||||
* out the architecture port can save*/
|
||||
POINTER sp_save_ptr;
|
||||
|
||||
/* Thread priority (0-255) */
|
||||
uint8_t priority;
|
||||
|
||||
/* Thread entry point and parameter */
|
||||
void (*entry_point)(uint32_t);
|
||||
uint32_t entry_param;
|
||||
|
||||
/* Queue pointers */
|
||||
struct atom_tcb *prev_tcb; /* Previous TCB in doubly-linked TCB list */
|
||||
struct atom_tcb *next_tcb; /* Next TCB in doubly-linked list */
|
||||
|
||||
/* Suspension data */
|
||||
uint8_t suspended; /* TRUE if task is currently suspended */
|
||||
uint8_t suspend_wake_status; /* Status returned to woken suspend calls */
|
||||
ATOM_TIMER *suspend_timo_cb; /* Callback registered for suspension timeouts */
|
||||
|
||||
} ATOM_TCB;
|
||||
|
||||
|
||||
/* Global data */
|
||||
extern ATOM_TCB *tcbReadyQ;
|
||||
extern uint8_t atomOSStarted;
|
||||
|
||||
|
||||
/* Constants */
|
||||
#define TRUE 1
|
||||
#define FALSE 0
|
||||
|
||||
/* Error values */
|
||||
|
||||
#define ATOM_OK 0
|
||||
#define ATOM_ERROR 1
|
||||
#define ATOM_TIMEOUT 2
|
||||
#define ATOM_WOULDBLOCK 3
|
||||
#define ATOM_ERR_CONTEXT 200
|
||||
#define ATOM_ERR_PARAM 201
|
||||
#define ATOM_ERR_DELETED 202
|
||||
#define ATOM_ERR_OVF 203
|
||||
#define ATOM_ERR_QUEUE 204
|
||||
#define ATOM_ERR_TIMER 205
|
||||
#define ATOM_ERR_NOT_FOUND 206
|
||||
#define ATOM_ERR_OWNERSHIP 207
|
||||
|
||||
/* Idle thread priority (lowest) */
|
||||
#define IDLE_THREAD_PRIORITY 255
|
||||
|
||||
|
||||
/* Function prototypes */
|
||||
extern uint8_t atomOSInit (void *idle_thread_stack_top);
|
||||
extern void atomOSStart (void);
|
||||
|
||||
extern void atomSched (uint8_t timer_tick);
|
||||
|
||||
extern void atomIntEnter (void);
|
||||
extern void atomIntExit (uint8_t timer_tick);
|
||||
|
||||
extern uint8_t tcbEnqueuePriority (ATOM_TCB **tcb_queue_ptr, ATOM_TCB *tcb_ptr);
|
||||
extern ATOM_TCB *tcbDequeueHead (ATOM_TCB **tcb_queue_ptr);
|
||||
extern ATOM_TCB *tcbDequeueEntry (ATOM_TCB **tcb_queue_ptr, ATOM_TCB *tcb_ptr);
|
||||
extern ATOM_TCB *tcbDequeuePriority (ATOM_TCB **tcb_queue_ptr, uint8_t priority);
|
||||
|
||||
extern ATOM_TCB *atomCurrentContext (void);
|
||||
|
||||
extern uint8_t atomThreadCreate (ATOM_TCB *tcb_ptr, uint8_t priority, void (*entry_point)(uint32_t), uint32_t entry_param, void *stack_top);
|
||||
|
||||
extern void archContextSwitch (ATOM_TCB *old_tcb_ptr, ATOM_TCB *new_tcb_ptr);
|
||||
extern void archThreadContextInit (ATOM_TCB *tcb_ptr, void *stack_top, void (*entry_point)(uint32_t), uint32_t entry_param);
|
||||
extern void archFirstThreadRestore(ATOM_TCB *new_tcb_ptr);
|
||||
|
||||
extern void atomTimerTick (void);
|
||||
|
||||
|
||||
#endif /* __ATOM_H */
|
||||
Reference in New Issue
Block a user