summaryrefslogtreecommitdiffstats
path: root/firmware/thread.c
blob: a4981af256054eef492f4bb300aebb0d2bf58120 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2002 by Ulf Ralberg
 *
 * All files in this archive are subject to the GNU General Public License.
 * See the file COPYING in the source tree root for full license agreement.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/
#include "config.h"
#include <stdbool.h>
#include "thread.h"
#include "panic.h"
#include "sprintf.h"
#include "system.h"
#include "kernel.h"
#include "cpu.h"
#include "string.h"
#ifdef RB_PROFILE
#include <profile.h>
#endif

#if NUM_CORES > 1
# define IF_COP2(x) x
#else
# define IF_COP2(x) CURRENT_CORE
#endif

#define DEADBEEF ((unsigned int)0xdeadbeef)
/* Cast to the the machine int type, whose size could be < 4. */

struct core_entry cores[NUM_CORES] IBSS_ATTR;
struct thread_entry threads[MAXTHREADS] IBSS_ATTR;
#ifdef HAVE_SCHEDULER_BOOSTCTRL
static int boosted_threads IBSS_ATTR;
#endif

/* Define to enable additional checks for blocking violations etc. */
#define THREAD_EXTRA_CHECKS

static const char main_thread_name[] = "main";

extern int stackbegin[];
extern int stackend[];

#ifdef CPU_PP
#ifndef BOOTLOADER
extern int cop_stackbegin[];
extern int cop_stackend[];
#else
/* The coprocessor stack is not set up in the bootloader code, but the threading
 * is.  No threads are run on the coprocessor, so set up some dummy stack */
int *cop_stackbegin = stackbegin;
int *cop_stackend = stackend;
#endif
#endif

#if NUM_CORES > 1
#if 0
static long cores_locked IBSS_ATTR;

#define LOCK(...) do { } while (test_and_set(&cores_locked, 1))
#define UNLOCK(...) cores_locked = 0
#endif

/* #warning "Core locking mechanism should be fixed on H10/4G!" */

inline void lock_cores(void)
{
#if 0
    if (!cores[CURRENT_CORE].lock_issued)
    {
        LOCK();
        cores[CURRENT_CORE].lock_issued = true;
    }
#endif
}

inline void unlock_cores(void)
{
#if 0
    if (cores[CURRENT_CORE].lock_issued)
    {
        cores[CURRENT_CORE].lock_issued = false;
        UNLOCK();
    }
#endif
}

#endif

/* Conserve IRAM
static void add_to_list(struct thread_entry **list,
                        struct thread_entry *thread) ICODE_ATTR;
static void remove_from_list(struct thread_entry **list,
                             struct thread_entry *thread) ICODE_ATTR;
*/

void switch_thread(bool save_context, struct thread_entry **blocked_list) 
    ICODE_ATTR;

static inline void store_context(void* addr) __attribute__ ((always_inline));
static inline void load_context(const void* addr)
    __attribute__ ((always_inline));
static inline void core_sleep(void) __attribute__((always_inline));

#if defined(CPU_ARM)
/*---------------------------------------------------------------------------
 * Store non-volatile context.
 *---------------------------------------------------------------------------
 */
static inline void store_context(void* addr)
{
    asm volatile(
        "stmia  %0, { r4-r11, sp, lr }\n"
        : : "r" (addr)
    );
}

/*---------------------------------------------------------------------------
 * Load non-volatile context.
 *---------------------------------------------------------------------------
 */
static void start_thread(void (*thread_func)(void), const void* addr) __attribute__((naked,used));
static void start_thread(void (*thread_func)(void), const void* addr)
{
    /* r0 = thread_func, r1 = addr */
#if NUM_CORES > 1 && CONFIG_CPU != PP5002
    asm volatile (
        "mov    r2, #0           \n"
        "str    r2, [r1, #40]    \n"
        "ldr    r1, =0xf000f044  \n" /* invalidate this core's cache */
        "ldr    r2, [r1]         \n"
        "orr    r2, r2, #6       \n"
        "str    r2, [r1]         \n"
        "ldr    r1, =0x6000c000  \n"
    "1:                          \n"
        "ldr    r2, [r1]         \n"
        "tst    r2, #0x8000      \n"
        "bne    1b               \n"
        "mov    pc, r0           \n"
        : : : "r1", "r2"
    );
#else
    asm volatile (
        "mov    r2, #0           \n"
        "str    r2, [r1, #40]    \n"
        "mov    pc, r0           \n"
        : : : "r1", "r2"
    );
#endif
    (void)thread_func;
    (void)addr;
}

static inline void load_context(const void* addr)
{
    asm volatile(
        "ldmia  %0, { r4-r11, sp, lr } \n" /* load regs r4 to r14 from context */
        "ldr    r0, [%0, #40]          \n" /* load start pointer */
        "cmp    r0, #0                 \n" /* check for NULL */
        "movne  r1, %0                 \n" /* if not already running, jump to start */
        "ldrne  pc, =start_thread      \n" 
        : : "r" (addr) : "r0", "r1"
    );
}

#if defined (CPU_PP)
static inline void core_sleep(void)
{
    unlock_cores();

    /* This should sleep the CPU. It appears to wake by itself on
       interrupts */
    if (CURRENT_CORE == CPU)
        CPU_CTL = PROC_SLEEP;
    else
        COP_CTL = PROC_SLEEP;

    lock_cores();
}
#elif CONFIG_CPU == S3C2440
static inline void core_sleep(void)
{
    int i;
    CLKCON |= (1 << 2); /* set IDLE bit */
    for(i=0; i<10; i++); /* wait for IDLE */
    CLKCON &= ~(1 << 2); /* reset IDLE bit when wake up */
}
#endif

#elif defined(CPU_COLDFIRE)
/*---------------------------------------------------------------------------
 * Store non-volatile context.
 *---------------------------------------------------------------------------
 */
static inline void store_context(void* addr)
{
    asm volatile (
        "move.l  %%macsr,%%d0    \n"
        "movem.l %%d0/%%d2-%%d7/%%a2-%%a7,(%0)   \n"
        : : "a" (addr) : "d0" /* only! */
    );
}

/*---------------------------------------------------------------------------
 * Load non-volatile context.
 *---------------------------------------------------------------------------
 */
static inline void load_context(const void* addr)
{
    asm volatile (
        "movem.l (%0),%%d0/%%d2-%%d7/%%a2-%%a7   \n"  /* Load context */
        "move.l  %%d0,%%macsr    \n"
        "move.l  (52,%0),%%d0    \n"  /* Get start address */
        "beq.b   1f              \n"  /* NULL -> already running */
        "clr.l   (52,%0)         \n"  /* Clear start address.. */
        "move.l  %%d0,%0         \n"
        "jmp     (%0)            \n"  /* ..and start the thread */
    "1:                          \n"
        : : "a" (addr) : "d0" /* only! */
    );
}

static inline void core_sleep(void)
{
    asm volatile ("stop #0x2000");
}

/* Set EMAC unit to fractional mode with saturation for each new thread,
   since that's what'll be the most useful for most things which the dsp
   will do. Codecs should still initialize their preferred modes
   explicitly. */
#define THREAD_CPU_INIT(core, thread) \
    ({ (thread)->context.macsr = EMAC_FRACTIONAL | EMAC_SATURATE; })

#elif CONFIG_CPU == SH7034
/*---------------------------------------------------------------------------
 * Store non-volatile context.
 *---------------------------------------------------------------------------
 */
static inline void store_context(void* addr)
{
    asm volatile (
        "add     #36,%0    \n"
        "sts.l   pr, @-%0  \n"
        "mov.l   r15,@-%0  \n"
        "mov.l   r14,@-%0  \n"
        "mov.l   r13,@-%0  \n"
        "mov.l   r12,@-%0  \n"
        "mov.l   r11,@-%0  \n"
        "mov.l   r10,@-%0  \n"
        "mov.l   r9, @-%0  \n"
        "mov.l   r8, @-%0  \n"
        : : "r" (addr)
    );
}

/*---------------------------------------------------------------------------
 * Load non-volatile context.
 *---------------------------------------------------------------------------
 */
static inline void load_context(const void* addr)
{
    asm volatile (
        "mov.l   @%0+,r8   \n"
        "mov.l   @%0+,r9   \n"
        "mov.l   @%0+,r10  \n"
        "mov.l   @%0+,r11  \n"
        "mov.l   @%0+,r12  \n"
        "mov.l   @%0+,r13  \n"
        "mov.l   @%0+,r14  \n"
        "mov.l   @%0+,r15  \n"
        "lds.l   @%0+,pr   \n"
        "mov.l   @%0,r0    \n"  /* Get start address */
        "tst     r0,r0     \n"
        "bt      .running  \n"  /* NULL -> already running */
        "lds     r0,pr     \n"
        "mov     #0,r0     \n"
        "rts               \n"  /* Start the thread */
        "mov.l   r0,@%0    \n"  /* Clear start address */
    ".running:             \n"
        : : "r" (addr) : "r0" /* only! */
    );
}

static inline void core_sleep(void)
{
    and_b(0x7F, &SBYCR);
    asm volatile ("sleep");
}

#endif

#ifndef THREAD_CPU_INIT
/* No cpu specific init - make empty */
#define THREAD_CPU_INIT(core, thread)
#endif

#ifdef THREAD_EXTRA_CHECKS
static void thread_panicf_format_name(char *buffer, struct thread_entry *thread)
{
    *buffer = '\0';
    if (thread)
    {
        /* Display thread name if one or ID if none */
        const char *fmt = thread->name ? " %s" : " %08lX";
        intptr_t name = thread->name ?
            (intptr_t)thread->name : (intptr_t)thread;
        snprintf(buffer, 16, fmt, name);
    }
}

static void thread_panicf(const char *msg,
    struct thread_entry *thread1, struct thread_entry *thread2)
{
    static char thread1_name[16], thread2_name[16];
    thread_panicf_format_name(thread1_name, thread1);
    thread_panicf_format_name(thread2_name, thread2);
    panicf ("%s%s%s", msg, thread1_name, thread2_name);
}
#else
static void thread_stkov(void)
{
    /* Display thread name if one or ID if none */
    struct thread_entry *current = cores[CURRENT_CORE].running;
    const char *fmt = current->name ? "%s %s" : "%s %08lX";
    intptr_t name = current->name ?
            (intptr_t)current->name : (intptr_t)current;
    panicf(fmt, "Stkov", name);
}
#endif /* THREAD_EXTRA_CHECKS */

static void add_to_list(struct thread_entry **list, struct thread_entry *thread)
{
    if (*list == NULL)
    {
        thread->next = thread;
        thread->prev = thread;
        *list = thread;
    }
    else
    {
        /* Insert last */
        thread->next = *list;
        thread->prev = (*list)->prev;
        thread->prev->next = thread;
        (*list)->prev = thread;
        
        /* Insert next
         thread->next = (*list)->next;
         thread->prev = *list;
         thread->next->prev = thread;
         (*list)->next = thread;
         */
    }
}

static void remove_from_list(struct thread_entry **list,
                      struct thread_entry *thread)
{
    if (list != NULL)
    {
        if (thread == thread->next)
        {
            *list = NULL;
            return;
        }
        
        if (thread == *list)
            *list = thread->next;
    }
    
    /* Fix links to jump over the removed entry. */
    thread->prev->next = thread->next;
    thread->next->prev = thread->prev;
}

static void check_sleepers(void) __attribute__ ((noinline));
static void check_sleepers(void)
{
    const unsigned int core = CURRENT_CORE;
    struct thread_entry *current, *next;
    
    /* Check sleeping threads. */
    current = cores[core].sleeping;
    
    for (;;)
    {
        next = current->next;
        
        if ((unsigned)current_tick >= GET_STATE_ARG(current->statearg))
        {
            /* Sleep timeout has been reached so bring the thread
             * back to life again. */
            remove_from_list(&cores[core].sleeping, current);
            add_to_list(&cores[core].running, current);
            current->statearg = 0;
            
            /* If there is no more processes in the list, break the loop. */
            if (cores[core].sleeping == NULL)
                break;
            
            current = next;
            continue;
        }
        
        current = next;
        
        /* Break the loop once we have walked through the list of all
         * sleeping processes. */
        if (current == cores[core].sleeping)
            break;
    }
}

/* Safely finish waking all threads potentialy woken by interrupts -
 * statearg already zeroed in wakeup_thread. */
static void wake_list_awaken(void) __attribute__ ((noinline));
static void wake_list_awaken(void)
{
    const unsigned int core = CURRENT_CORE;
    int oldlevel = set_irq_level(HIGHEST_IRQ_LEVEL);

    /* No need for another check in the IRQ lock since IRQs are allowed
       only to add threads to the waking list. They won't be adding more
       until we're done here though. */

    struct thread_entry *waking = cores[core].waking;
    struct thread_entry *running = cores[core].running;

    if (running != NULL)
    {
        /* Place waking threads at the end of the running list. */
        struct thread_entry *tmp;
        waking->prev->next  = running;
        running->prev->next = waking;
        tmp                 = running->prev;
        running->prev       = waking->prev;
        waking->prev        = tmp;
    }
    else
    {
        /* Just transfer the list as-is - just came out of a core
         * sleep. */
        cores[core].running = waking;
    }

    /* Done with waking list */
    cores[core].waking = NULL;
    set_irq_level(oldlevel);
}

static inline void sleep_core(void)
{
    const unsigned int core = CURRENT_CORE;

    for (;;)
    {
        /* We want to do these ASAP as it may change the decision to sleep
           the core or the core has woken because an interrupt occurred
           and posted a message to a queue. */
        if (cores[core].waking != NULL)
            wake_list_awaken();

        if (cores[core].last_tick != current_tick)
        {
            if (cores[core].sleeping != NULL)
                check_sleepers();
            cores[core].last_tick = current_tick;
        }
        
        /* We must sleep until there is at least one process in the list
         * of running processes. */
        if (cores[core].running != NULL)
            break;

        /* Enter sleep mode to reduce power usage, woken up on interrupt */
        core_sleep();
    }
}

#ifdef RB_PROFILE
static int get_threadnum(struct thread_entry *thread)
{
    int i;
    
    for (i = 0; i < MAXTHREADS; i++)
    {
        if (&threads[i] == thread)
            return i;
    }
    
    return -1;
}

void profile_thread(void) {
    profstart(get_threadnum(cores[CURRENT_CORE].running));
}
#endif

static void change_thread_state(struct thread_entry **blocked_list) __attribute__ ((noinline));
static void change_thread_state(struct thread_entry **blocked_list)
{
    const unsigned int core = CURRENT_CORE;
    struct thread_entry *old;
    unsigned long new_state;
    
    /* Remove the thread from the list of running threads. */
    old = cores[core].running;
    new_state = GET_STATE(old->statearg);

    /* Check if a thread state change has been requested. */
    if (new_state)
    {
        /* Change running thread state and switch to next thread. */
        remove_from_list(&cores[core].running, old);
        
        /* And put the thread into a new list of inactive threads. */
        if (new_state == STATE_BLOCKED)
            add_to_list(blocked_list, old);
        else
            add_to_list(&cores[core].sleeping, old);
        
#ifdef HAVE_PRIORITY_SCHEDULING
        /* Reset priorities */
        if (old->priority == cores[core].highest_priority)
            cores[core].highest_priority = 100;
#endif
    }
    else
        /* Switch to the next running thread. */
        cores[core].running = old->next;
}

/*---------------------------------------------------------------------------
 * Switch thread in round robin fashion.
 *---------------------------------------------------------------------------
 */
void switch_thread(bool save_context, struct thread_entry **blocked_list)
{
    const unsigned int core = CURRENT_CORE;

#ifdef RB_PROFILE
    profile_thread_stopped(get_threadnum(cores[core].running));
#endif
    unsigned int *stackptr;
    
#ifdef SIMULATOR
    /* Do nothing */
#else

    lock_cores();
    
    /* Begin task switching by saving our current context so that we can
     * restore the state of the current thread later to the point prior
     * to this call. */
    if (save_context)
    {
        store_context(&cores[core].running->context);

        /* Check if the current thread stack is overflown */
        stackptr = cores[core].running->stack;
        if(stackptr[0] != DEADBEEF)
#ifdef THREAD_EXTRA_CHECKS
            thread_panicf("Stkov", cores[core].running, NULL);
#else
            thread_stkov();
#endif
    
        /* Rearrange thread lists as needed */
        change_thread_state(blocked_list);

        /* This has to be done after the scheduler is finished with the
           blocked_list pointer so that an IRQ can't kill us by attempting
           a wake but before attempting any core sleep. */
        if (cores[core].switch_to_irq_level != STAY_IRQ_LEVEL)
        {
            int level = cores[core].switch_to_irq_level;
            cores[core].switch_to_irq_level = STAY_IRQ_LEVEL;
            set_irq_level(level);
        }
    }
    
    /* Go through the list of sleeping task to check if we need to wake up
     * any of them due to timeout. Also puts core into sleep state until
     * there is at least one running process again. */
    sleep_core();
    
#ifdef HAVE_PRIORITY_SCHEDULING
    /* Select the new task based on priorities and the last time a process
     * got CPU time. */
    for (;;)
    {
        int priority = cores[core].running->priority;

        if (priority < cores[core].highest_priority)
            cores[core].highest_priority = priority;

        if (priority == cores[core].highest_priority ||
                (current_tick - cores[core].running->last_run >
                 priority * 8) ||
            cores[core].running->priority_x != 0)
        {
            break;
        }

        cores[core].running = cores[core].running->next;
    }
    
    /* Reset the value of thread's last running time to the current time. */
    cores[core].running->last_run = current_tick;
#endif
    
#endif
    unlock_cores();
    
    /* And finally give control to the next thread. */
    load_context(&cores[core].running->context);
    
#ifdef RB_PROFILE
    profile_thread_started(get_threadnum(cores[core].running));
#endif
}

void sleep_thread(int ticks)
{
    struct thread_entry *current;

    lock_cores();
    
    current = cores[CURRENT_CORE].running;

#ifdef HAVE_SCHEDULER_BOOSTCTRL
    if (STATE_IS_BOOSTED(current->statearg))
    {
        boosted_threads--;
        if (!boosted_threads)
        {
            cpu_boost(false);
        }
    }
#endif

    /* Set the thread's new state and timeout and finally force a task switch
     * so that scheduler removes thread from the list of running processes
     * and puts it in list of sleeping tasks. */
    SET_STATE(current->statearg, STATE_SLEEPING, current_tick + ticks + 1);
    
    switch_thread(true, NULL);
}

void block_thread(struct thread_entry **list)
{
    struct thread_entry *current;
    
    lock_cores();
    
    /* Get the entry for the current running thread. */
    current = cores[CURRENT_CORE].running;

#ifdef HAVE_SCHEDULER_BOOSTCTRL
    /* Keep the boosted state over indefinite block calls, because
     * we are waiting until the earliest time that someone else
     * completes an action */
    unsigned long boost_flag = STATE_IS_BOOSTED(current->statearg);
#endif

#ifdef THREAD_EXTRA_CHECKS
    /* We are not allowed to mix blocking types in one queue. */
    if (*list && GET_STATE((*list)->statearg) == STATE_BLOCKED_W_TMO)
        thread_panicf("Blocking violation B->*T", current, *list);
#endif
    
    /* Set the state to blocked and ask the scheduler to switch tasks,
     * this takes us off of the run queue until we are explicitly woken */
    SET_STATE(current->statearg, STATE_BLOCKED, 0);

    switch_thread(true, list);

#ifdef HAVE_SCHEDULER_BOOSTCTRL
    /* Reset only the boosted flag to indicate we are up and running again. */
    current->statearg = boost_flag;
#else
    /* Clear all flags to indicate we are up and running again. */
    current->statearg = 0;
#endif
}

void block_thread_w_tmo(struct thread_entry **list, int timeout)
{
    struct thread_entry *current;
    /* Get the entry for the current running thread. */
    current = cores[CURRENT_CORE].running;
    
    lock_cores();
#ifdef HAVE_SCHEDULER_BOOSTCTRL
    /* A block with a timeout is a sleep situation, whatever we are waiting
     * for _may or may not_ happen, regardless of boost state, (user input
     * for instance), so this thread no longer needs to boost */
    if (STATE_IS_BOOSTED(current->statearg))
    {
        boosted_threads--;
        if (!boosted_threads)
        {
            cpu_boost(false);
        }
    }
#endif

#ifdef THREAD_EXTRA_CHECKS
    /* We can store only one thread to the "list" if thread is used
     * in other list (such as core's list for sleeping tasks). */
    if (*list)
        thread_panicf("Blocking violation T->*B", current, NULL);
#endif
    
    /* Set the state to blocked with the specified timeout */
    SET_STATE(current->statearg, STATE_BLOCKED_W_TMO, current_tick + timeout);

    /* Set the "list" for explicit wakeup */
    *list = current;

    /* Now force a task switch and block until we have been woken up
     * by another thread or timeout is reached. */
    switch_thread(true, NULL);

    /* It is now safe for another thread to block on this "list" */
    *list = NULL;
}

#if !defined(SIMULATOR)
void set_irq_level_and_block_thread(struct thread_entry **list, int level)
{
    cores[CURRENT_CORE].switch_to_irq_level = level;
    block_thread(list);
}

void set_irq_level_and_block_thread_w_tmo(struct thread_entry **list,
                                          int timeout, int level)
{
    cores[CURRENT_CORE].switch_to_irq_level = level;
    block_thread_w_tmo(list, timeout);
}
#endif

void wakeup_thread(struct thread_entry **list)
{
    struct thread_entry *thread;
    
    /* Check if there is a blocked thread at all. */
    if (*list == NULL)
    {
        return ;
    }
    
    /* Wake up the last thread first. */
    thread = *list;
    
    /* Determine thread's current state. */
    switch (GET_STATE(thread->statearg)) 
    {
        case STATE_BLOCKED:
            /* Remove thread from the list of blocked threads and add it
             * to the scheduler's list of running processes. List removal
             * is safe since each object maintains it's own list of
             * sleepers and queues protect against reentrancy. */
            remove_from_list(list, thread);
            add_to_list(cores[IF_COP2(thread->core)].wakeup_list, thread);

        case STATE_BLOCKED_W_TMO:
            /* Just remove the timeout to cause scheduler to immediately
             * wake up the thread. */
            thread->statearg = 0;
            break;
        
        default:
            /* Nothing to do. Thread has already been woken up
             * or it's state is not blocked or blocked with timeout. */
            return ;
    }
}

inline static int find_empty_thread_slot(void)
{
    int n;
    
    for (n = 0; n < MAXTHREADS; n++)
    {
        if (threads[n].name == NULL)
            return n;
    }
    
    return -1;
}

/* Like wakeup_thread but safe against IRQ corruption when IRQs are disabled
   before calling. */
void wakeup_thread_irq_safe(struct thread_entry **list)
{
    struct core_entry *core = &cores[CURRENT_CORE];
    /* Switch wakeup lists and call wakeup_thread */
    core->wakeup_list = &core->waking;
    wakeup_thread(list);
    /* Switch back to normal running list */
    core->wakeup_list = &core->running;
}

/*---------------------------------------------------------------------------
 * Create a thread
 * If using a dual core architecture, specify which core to start the thread
 * on, and whether to fall back to the other core if it can't be created
 * Return ID if context area could be allocated, else NULL.
 *---------------------------------------------------------------------------
 */
struct thread_entry* 
    create_thread(void (*function)(void), void* stack, int stack_size,
                  const char *name IF_PRIO(, int priority)
          IF_COP(, unsigned int core, bool fallback))
{
    unsigned int i;
    unsigned int stacklen;
    unsigned int *stackptr;
    int slot;
    struct regs *regs;
    struct thread_entry *thread;

/*****
 * Ugly code alert!
 * To prevent ifdef hell while keeping the binary size down, we define
 * core here if it hasn't been passed as a parameter
 *****/
#if NUM_CORES == 1
#define core CPU
#endif

#if NUM_CORES > 1
/* If the kernel hasn't initialised on the COP (most likely due to an old
 * bootloader) then refuse to start threads on the COP
 */
    if ((core == COP) && !cores[core].kernel_running)
    {
        if (fallback)
            return create_thread(function, stack, stack_size, name
                                 IF_PRIO(, priority) IF_COP(, CPU, false));
        else
            return NULL;
    }
#endif

    lock_cores();
    
    slot = find_empty_thread_slot();
    if (slot < 0)
    {
        unlock_cores();
        return NULL;
    }
    
    /* Munge the stack to make it easy to spot stack overflows */
    stacklen = stack_size / sizeof(int);
    stackptr = stack;
    for(i = 0;i < stacklen;i++)
    {
        stackptr[i] = DEADBEEF;
    }

    /* Store interesting information */
    thread = &threads[slot];
    thread->name = name;
    thread->stack = stack;
    thread->stack_size = stack_size;
    thread->statearg = 0;
#ifdef HAVE_PRIORITY_SCHEDULING
    thread->priority_x = 0;
    thread->priority = priority;
    cores[core].highest_priority = 100;
#endif

#if NUM_CORES > 1
    thread->core = core;

    /* Writeback stack munging or anything else before starting */
    if (core != CURRENT_CORE)
        flush_icache();
#endif
    
    regs = &thread->context;
    /* Align stack to an even 32 bit boundary */
    regs->sp = (void*)(((unsigned int)stack + stack_size) & ~3);
    regs->start = (void*)function;

    /* Do any CPU specific inits after initializing common items
       to have access to valid data */
    THREAD_CPU_INIT(core, thread);
    
    add_to_list(&cores[core].running, thread);
    unlock_cores();

    return thread;
#if NUM_CORES == 1
#undef core
#endif
}

#ifdef HAVE_SCHEDULER_BOOSTCTRL
void trigger_cpu_boost(void)
{
    lock_cores();
    
    if (!STATE_IS_BOOSTED(cores[CURRENT_CORE].running->statearg))
    {
        SET_BOOST_STATE(cores[CURRENT_CORE].running->statearg);
        if (!boosted_threads)
        {
            cpu_boost(true);
        }
        boosted_threads++;
    }
    
    unlock_cores();
}
#endif

/*---------------------------------------------------------------------------
 * Remove a thread on the current core from the scheduler.
 * Parameter is the ID as returned from create_thread().
 *---------------------------------------------------------------------------
 */
void remove_thread(struct thread_entry *thread)
{
    lock_cores();

    if (thread == NULL)
        thread = cores[CURRENT_CORE].running;
    
    /* Free the entry by removing thread name. */
    thread->name = NULL;
#ifdef HAVE_PRIORITY_SCHEDULING
    cores[IF_COP2(thread->core)].highest_priority = 100;
#endif
    
    if (thread == cores[IF_COP2(thread->core)].running)
    {
        remove_from_list(&cores[IF_COP2(thread->core)].running, thread);
        switch_thread(false, NULL);
        return ;
    }
    
    if (thread == cores[IF_COP2(thread->core)].sleeping)
        remove_from_list(&cores[IF_COP2(thread->core)].sleeping, thread);
    else
        remove_from_list(NULL, thread);
    
    unlock_cores();
}

#ifdef HAVE_PRIORITY_SCHEDULING
int thread_set_priority(struct thread_entry *thread, int priority)
{
    int old_priority;
    
    lock_cores();
    if (thread == NULL)
        thread = cores[CURRENT_CORE].running;

    old_priority = thread->priority;
    thread->priority = priority;
    cores[IF_COP2(thread->core)].highest_priority = 100;
    unlock_cores();
    
    return old_priority;
}

int thread_get_priority(struct thread_entry *thread)
{
    if (thread == NULL)
        thread = cores[CURRENT_CORE].running;

    return thread->priority;
}

void priority_yield(void)
{
    struct thread_entry *thread = cores[CURRENT_CORE].running;
    thread->priority_x = 1;
    switch_thread(true, NULL);
    thread->priority_x = 0;
}
#endif /* HAVE_PRIORITY_SCHEDULING */

struct thread_entry * thread_get_current(void)
{
    return cores[CURRENT_CORE].running;
}

void init_threads(void)
{
    const unsigned int core = CURRENT_CORE;
    int slot;

    /* Let main CPU initialize first. */
#if NUM_CORES > 1
    if (core != CPU)
    {
        while (!cores[CPU].kernel_running) ;
    }
#endif
    
    lock_cores();
    slot = find_empty_thread_slot();
    
    cores[core].sleeping = NULL;
    cores[core].running = NULL;
    cores[core].waking = NULL;
    cores[core].wakeup_list = &cores[core].running;
#ifdef HAVE_EXTENDED_MESSAGING_AND_NAME
    cores[core].switch_to_irq_level = STAY_IRQ_LEVEL;
#endif
    threads[slot].name = main_thread_name;
    threads[slot].statearg = 0;
    threads[slot].context.start = 0; /* core's main thread already running */
#if NUM_CORES > 1
    threads[slot].core = core;
#endif
#ifdef HAVE_PRIORITY_SCHEDULING
    threads[slot].priority = PRIORITY_USER_INTERFACE;
    threads[slot].priority_x = 0;
    cores[core].highest_priority = 100;
#endif
#ifdef HAVE_SCHEDULER_BOOSTCTRL
    boosted_threads = 0;
#endif
    add_to_list(&cores[core].running, &threads[slot]);
    
    /* In multiple core setups, each core has a different stack.  There is
     * probably a much better way to do this. */
    if (core == CPU)
    {
        threads[slot].stack = stackbegin;
        threads[slot].stack_size = (int)stackend - (int)stackbegin;
    } 
#if NUM_CORES > 1  /* This code path will not be run on single core targets */
    else 
    {
        threads[slot].stack = cop_stackbegin;
        threads[slot].stack_size =
            (int)cop_stackend - (int)cop_stackbegin;
    }

    cores[core].kernel_running = true;
#endif
    
    unlock_cores();
}

int thread_stack_usage(const struct thread_entry *thread)
{
    unsigned int i;
    unsigned int *stackptr = thread->stack;

    for (i = 0;i < thread->stack_size/sizeof(int);i++)
    {
        if (stackptr[i] != DEADBEEF)
            break;
    }

    return ((thread->stack_size - i * sizeof(int)) * 100) /
        thread->stack_size;
}

int thread_get_status(const struct thread_entry *thread)
{
    return GET_STATE(thread->statearg);
}