raspi.h

/*
 * raspi.h -- Raspberry Pi kernel definitions
 *
 * Copyright 2014 Dale Schumacher, Tristan Slominski
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef _RASPI_H_
#define _RASPI_H_

typedef unsigned char u8;
typedef unsigned short u16;
typedef unsigned int u32;

typedef void (ACTOR)(void);

#ifndef NULL
#define NULL ((void*)0)
#endif

#ifndef EOF
#define EOF (-1)
#endif

/* public data structures */
extern const char hex[];  // hexadecimal characters
extern u8 heap_start[];  // dynamic allocation base

/* sponsor selection */
extern void set_sponsor(ACTOR* sl);
extern void sponsor_0();  // "default" sponsor
extern void sponsor_1();  // "fast" sponsor (no trace, watchdog, etc.)
extern void sponsor_2();  // "debug" sponsor (don't release events)

/* kernel entry-point */
extern void mycelia(ACTOR* sponsor, ACTOR* start, u32 trace);
extern void panic();

/* ARM assembly-language helper functions */
extern void PUT_32(u32 addr, u32 data);
extern u32 GET_32(u32 addr);
extern void NO_OP();
extern void SPIN(u32 count);
extern void BRANCH_TO(u32 addr);

/* macros to enhance efficiency */
#define PUT_32(addr, data)      (*((volatile u32*)(addr)) = (data))
#define GET_32(addr)            (*((volatile u32*)(addr)))

/* utilities from mycelia.s */
struct example_5 {
    u32         code_00;
    u32         data_04;
    u32         data_08;
    u32         data_0c;
    u32         data_10;
    u32         data_14;
    u32         data_18;
    ACTOR*      beh_1c;
};

extern void* reserve();  // allocate 32-byte block -- WARNING! sponsor required
extern void release(void* block);  // free reserved block
extern struct example_5 *create_5(ACTOR* behavior);

/* C helpers from raspberry.c */
extern int putchar(int c);
extern void puts(char* s);
extern int getchar();
extern void serial_hex8(u8 b);
extern void serial_hex16(u16 d);
extern void serial_hex32(u32 w);
extern void serial_dec32(u32 w);
extern void serial_int32(int n);
extern void hexdump(const u8* p, int n);
extern void dump_words(const u32* p, int n);
extern void dump256(void* p);
extern void dump_block(const u32* p);
extern void dump_event(const u32* p);
extern char* editline();

#endif /* _RASPI_H_ */