12375d1d3a
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29492 a1c6a512-1295-4272-9138-f99709370657
277 lines
11 KiB
C
277 lines
11 KiB
C
/***************************************************************************
|
|
* __________ __ ___.
|
|
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
|
|
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
|
|
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
|
|
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
|
|
* \/ \/ \/ \/ \/
|
|
* $Id$
|
|
*
|
|
* Copyright (C) 2002 by Björn Stenberg
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
****************************************************************************/
|
|
#ifndef _KERNEL_H_
|
|
#define _KERNEL_H_
|
|
|
|
#include <stdbool.h>
|
|
#include <inttypes.h>
|
|
#include "config.h"
|
|
|
|
#include "thread.h"
|
|
|
|
/* wrap-safe macros for tick comparison */
|
|
#define TIME_AFTER(a,b) ((long)(b) - (long)(a) < 0)
|
|
#define TIME_BEFORE(a,b) TIME_AFTER(b,a)
|
|
|
|
#define HZ 100 /* number of ticks per second */
|
|
|
|
#define MAX_NUM_TICK_TASKS 8
|
|
|
|
#define MAX_NUM_QUEUES 32
|
|
#define QUEUE_LENGTH 16 /* MUST be a power of 2 */
|
|
#define QUEUE_LENGTH_MASK (QUEUE_LENGTH - 1)
|
|
|
|
/* System defined message ID's - |sign bit = 1|class|id| */
|
|
/* Event class list */
|
|
#define SYS_EVENT_CLS_QUEUE 0
|
|
#define SYS_EVENT_CLS_USB 1
|
|
#define SYS_EVENT_CLS_POWER 2
|
|
#define SYS_EVENT_CLS_FILESYS 3
|
|
#define SYS_EVENT_CLS_PLUG 4
|
|
#define SYS_EVENT_CLS_MISC 5
|
|
#define SYS_EVENT_CLS_PRIVATE 7 /* For use inside plugins */
|
|
/* make sure SYS_EVENT_CLS_BITS has enough range */
|
|
|
|
/* Bit 31->|S|c...c|i...i| */
|
|
#define SYS_EVENT ((long)(int)(1 << 31))
|
|
#define SYS_EVENT_CLS_BITS (3)
|
|
#define SYS_EVENT_CLS_SHIFT (31-SYS_EVENT_CLS_BITS)
|
|
#define SYS_EVENT_CLS_MASK (((1l << SYS_EVENT_CLS_BITS)-1) << SYS_EVENT_SHIFT)
|
|
#define MAKE_SYS_EVENT(cls, id) (SYS_EVENT | ((long)(cls) << SYS_EVENT_CLS_SHIFT) | (long)(id))
|
|
/* Macros for extracting codes */
|
|
#define SYS_EVENT_CLS(e) (((e) & SYS_EVENT_CLS_MASK) >> SYS_EVENT_SHIFT)
|
|
#define SYS_EVENT_ID(e) ((e) & ~(SYS_EVENT|SYS_EVENT_CLS_MASK))
|
|
|
|
#define SYS_TIMEOUT MAKE_SYS_EVENT(SYS_EVENT_CLS_QUEUE, 0)
|
|
#define SYS_USB_CONNECTED MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 0)
|
|
#define SYS_USB_CONNECTED_ACK MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 1)
|
|
#define SYS_USB_DISCONNECTED MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 2)
|
|
#define SYS_USB_LUN_LOCKED MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 4)
|
|
#define SYS_USB_READ_DATA MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 5)
|
|
#define SYS_USB_WRITE_DATA MAKE_SYS_EVENT(SYS_EVENT_CLS_USB, 6)
|
|
#define SYS_POWEROFF MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 0)
|
|
#define SYS_CHARGER_CONNECTED MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 1)
|
|
#define SYS_CHARGER_DISCONNECTED MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 2)
|
|
#define SYS_BATTERY_UPDATE MAKE_SYS_EVENT(SYS_EVENT_CLS_POWER, 3)
|
|
#define SYS_FS_CHANGED MAKE_SYS_EVENT(SYS_EVENT_CLS_FILESYS, 0)
|
|
#define SYS_HOTSWAP_INSERTED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 0)
|
|
#define SYS_HOTSWAP_EXTRACTED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 1)
|
|
#define SYS_PHONE_PLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 2)
|
|
#define SYS_PHONE_UNPLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 3)
|
|
#define SYS_REMOTE_PLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 4)
|
|
#define SYS_REMOTE_UNPLUGGED MAKE_SYS_EVENT(SYS_EVENT_CLS_PLUG, 5)
|
|
#define SYS_CAR_ADAPTER_RESUME MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 0)
|
|
#define SYS_IAP_PERIODIC MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 1)
|
|
#define SYS_IAP_HANDLEPKT MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 2)
|
|
#define SYS_CALL_INCOMING MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 3)
|
|
#define SYS_CALL_HUNG_UP MAKE_SYS_EVENT(SYS_EVENT_CLS_MISC, 4)
|
|
|
|
#define IS_SYSEVENT(ev) ((ev & SYS_EVENT) == SYS_EVENT)
|
|
|
|
#ifndef TIMEOUT_BLOCK
|
|
#define TIMEOUT_BLOCK -1
|
|
#define TIMEOUT_NOBLOCK 0
|
|
#endif
|
|
|
|
struct queue_event
|
|
{
|
|
long id;
|
|
intptr_t data;
|
|
};
|
|
|
|
#ifdef HAVE_EXTENDED_MESSAGING_AND_NAME
|
|
struct queue_sender_list
|
|
{
|
|
/* If non-NULL, there is a thread waiting for the corresponding event */
|
|
/* Must be statically allocated to put in non-cached ram. */
|
|
struct thread_entry *senders[QUEUE_LENGTH]; /* message->thread map */
|
|
struct thread_entry *list; /* list of senders in map */
|
|
/* Send info for last message dequeued or NULL if replied or not sent */
|
|
struct thread_entry * volatile curr_sender;
|
|
#ifdef HAVE_PRIORITY_SCHEDULING
|
|
struct blocker blocker;
|
|
#endif
|
|
};
|
|
#endif /* HAVE_EXTENDED_MESSAGING_AND_NAME */
|
|
|
|
#ifdef HAVE_PRIORITY_SCHEDULING
|
|
#define QUEUE_GET_THREAD(q) \
|
|
(((q)->send == NULL) ? NULL : (q)->send->blocker.thread)
|
|
#else
|
|
/* Queue without priority enabled have no owner provision _at this time_ */
|
|
#define QUEUE_GET_THREAD(q) \
|
|
(NULL)
|
|
#endif
|
|
|
|
struct event_queue
|
|
{
|
|
struct thread_entry *queue; /* waiter list */
|
|
struct queue_event events[QUEUE_LENGTH]; /* list of events */
|
|
unsigned int volatile read; /* head of queue */
|
|
unsigned int volatile write; /* tail of queue */
|
|
#ifdef HAVE_EXTENDED_MESSAGING_AND_NAME
|
|
struct queue_sender_list * volatile send; /* list of threads waiting for
|
|
reply to an event */
|
|
#ifdef HAVE_PRIORITY_SCHEDULING
|
|
struct blocker *blocker_p; /* priority inheritance info
|
|
for sync message senders */
|
|
#endif
|
|
#endif
|
|
IF_COP( struct corelock cl; ) /* multiprocessor sync */
|
|
};
|
|
|
|
struct mutex
|
|
{
|
|
struct thread_entry *queue; /* waiter list */
|
|
int recursion; /* lock owner recursion count */
|
|
#ifdef HAVE_PRIORITY_SCHEDULING
|
|
struct blocker blocker; /* priority inheritance info
|
|
for waiters */
|
|
bool no_preempt; /* don't allow higher-priority thread
|
|
to be scheduled even if woken */
|
|
#else
|
|
struct thread_entry *thread; /* Indicates owner thread - an owner
|
|
implies a locked state - same goes
|
|
for priority scheduling
|
|
(in blocker struct for that) */
|
|
#endif
|
|
IF_COP( struct corelock cl; ) /* multiprocessor sync */
|
|
};
|
|
|
|
#ifdef HAVE_SEMAPHORE_OBJECTS
|
|
struct semaphore
|
|
{
|
|
struct thread_entry *queue; /* Waiter list */
|
|
int volatile count; /* # of waits remaining before unsignaled */
|
|
int max; /* maximum # of waits to remain signaled */
|
|
IF_COP( struct corelock cl; ) /* multiprocessor sync */
|
|
};
|
|
#endif
|
|
|
|
/* global tick variable */
|
|
#if defined(CPU_PP) && defined(BOOTLOADER) && \
|
|
!defined(HAVE_BOOTLOADER_USB_MODE)
|
|
/* We don't enable interrupts in the PP bootloader unless USB mode is
|
|
enabled for it, so we need to fake the current_tick variable */
|
|
#define current_tick (signed)(USEC_TIMER/10000)
|
|
|
|
static inline void call_tick_tasks(void)
|
|
{
|
|
}
|
|
#else
|
|
extern volatile long current_tick;
|
|
|
|
/* inline helper for implementing target interrupt handler */
|
|
static inline void call_tick_tasks(void)
|
|
{
|
|
extern void (*tick_funcs[MAX_NUM_TICK_TASKS+1])(void);
|
|
void (**p)(void) = tick_funcs;
|
|
void (*fn)(void);
|
|
|
|
current_tick++;
|
|
|
|
for(fn = *p; fn != NULL; fn = *(++p))
|
|
{
|
|
fn();
|
|
}
|
|
}
|
|
#endif
|
|
|
|
/* kernel functions */
|
|
extern void kernel_init(void) INIT_ATTR;
|
|
extern void yield(void);
|
|
extern unsigned sleep(unsigned ticks);
|
|
int tick_add_task(void (*f)(void));
|
|
int tick_remove_task(void (*f)(void));
|
|
extern void tick_start(unsigned int interval_in_ms) INIT_ATTR;
|
|
|
|
#ifdef INCLUDE_TIMEOUT_API
|
|
struct timeout;
|
|
|
|
/* timeout callback type
|
|
* tmo - pointer to struct timeout associated with event
|
|
* return next interval or <= 0 to stop event
|
|
*/
|
|
#define MAX_NUM_TIMEOUTS 8
|
|
typedef int (* timeout_cb_type)(struct timeout *tmo);
|
|
|
|
struct timeout
|
|
{
|
|
timeout_cb_type callback;/* callback - returning false cancels */
|
|
intptr_t data; /* data passed to callback */
|
|
long expires; /* expiration tick */
|
|
};
|
|
|
|
void timeout_register(struct timeout *tmo, timeout_cb_type callback,
|
|
int ticks, intptr_t data);
|
|
void timeout_cancel(struct timeout *tmo);
|
|
#endif /* INCLUDE_TIMEOUT_API */
|
|
|
|
#define STATE_NONSIGNALED 0
|
|
#define STATE_SIGNALED 1
|
|
|
|
#define OBJ_WAIT_TIMEDOUT (-1)
|
|
#define OBJ_WAIT_FAILED 0
|
|
#define OBJ_WAIT_SUCCEEDED 1
|
|
|
|
extern void queue_init(struct event_queue *q, bool register_queue);
|
|
extern void queue_delete(struct event_queue *q);
|
|
extern void queue_wait(struct event_queue *q, struct queue_event *ev);
|
|
extern void queue_wait_w_tmo(struct event_queue *q, struct queue_event *ev,
|
|
int ticks);
|
|
extern void queue_post(struct event_queue *q, long id, intptr_t data);
|
|
#ifdef HAVE_EXTENDED_MESSAGING_AND_NAME
|
|
extern void queue_enable_queue_send(struct event_queue *q,
|
|
struct queue_sender_list *send,
|
|
unsigned int owner_id);
|
|
extern intptr_t queue_send(struct event_queue *q, long id, intptr_t data);
|
|
extern void queue_reply(struct event_queue *q, intptr_t retval);
|
|
extern bool queue_in_queue_send(struct event_queue *q);
|
|
#endif /* HAVE_EXTENDED_MESSAGING_AND_NAME */
|
|
extern bool queue_empty(const struct event_queue* q);
|
|
extern bool queue_peek(struct event_queue *q, struct queue_event *ev);
|
|
extern void queue_clear(struct event_queue* q);
|
|
extern void queue_remove_from_head(struct event_queue *q, long id);
|
|
extern int queue_count(const struct event_queue *q);
|
|
extern int queue_broadcast(long id, intptr_t data);
|
|
|
|
extern void mutex_init(struct mutex *m);
|
|
extern void mutex_lock(struct mutex *m);
|
|
extern void mutex_unlock(struct mutex *m);
|
|
#ifdef HAVE_PRIORITY_SCHEDULING
|
|
/* Deprecated temporary function to disable mutex preempting a thread on
|
|
* unlock - firmware/drivers/fat.c and a couple places in apps/buffering.c -
|
|
* reliance on it is a bug! */
|
|
static inline void mutex_set_preempt(struct mutex *m, bool preempt)
|
|
{ m->no_preempt = !preempt; }
|
|
#else
|
|
/* Deprecated but needed for now - firmware/drivers/ata_mmc.c */
|
|
static inline bool mutex_test(const struct mutex *m)
|
|
{ return m->thread != NULL; }
|
|
#endif /* HAVE_PRIORITY_SCHEDULING */
|
|
|
|
#ifdef HAVE_SEMAPHORE_OBJECTS
|
|
extern void semaphore_init(struct semaphore *s, int max, int start);
|
|
extern int semaphore_wait(struct semaphore *s, int timeout);
|
|
extern void semaphore_release(struct semaphore *s);
|
|
#endif /* HAVE_SEMAPHORE_OBJECTS */
|
|
|
|
#endif /* _KERNEL_H_ */
|