iris/boot-programs/devices.hhp

#pypp 0
// Iris: micro-kernel for a capability-based operating system.
// boot-programs/devices.hhp: interfaces for core devices.
// Copyright 2009 Bas Wijnen <wijnen@debian.org>
//
// 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 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

#ifndef __IRIS_DEVICES_HH
#define __IRIS_DEVICES_HH

#include "iris.h"

// This shouldn't really be here.  But where should it be?
// Requests made by initial threads to tell init about themselves.
enum init_requests:
	INIT_SET_GPIO
	INIT_SET_LCD


// Keyboard interface.
enum Keyboard_request:
	KEYBOARD_SET_CB
	KEYBOARD_GET_KEYS

// Set the event callback.  Currently pressed keys emit a key press event to the new callback immediately, plus a ~0 to signal the end of such events.
static __inline__ void keyboard_set_cb (Capability kbd, Capability cb):
	invoke_11 (kbd, cb, KEYBOARD_SET_CB)
// At event: the callback is called with a keycode.  One bit defines if it's a press or release event.
#define KEYBOARD_RELEASE (1 << 31)

// Get a list of keys on this keyboard.  The key codes start at zero with no gaps.  The returned capability is a read-only list of strings.
static __inline__ void keyboard_get_keys (Capability target, Capability kbd):
	call_c01 (kbd, target, KEYBOARD_GET_KEYS)



// Display interface.
// Startup: disp_set_eof_cb, disp_create_fb, disp_use_fb, disp_info

// Register an end-of-frame callback.
// At end of frame, the callback is invoked and forgotten.  It must be reregistered to keep a stream of events.
static __inline__ void display_set_eof_cb (Capability disp_set_eof_cb, Capability cb):
	invoke_10 (disp_set_eof_cb, cb)

// Create a framebuffer for the display.  When not in use, it can be freed by the user.
// The pages must be cappages holding Page capabilities.  They are filled by the display.
// The passed numbers must be 0 or match a mode that the device can use.
// The returned number is the physical address of the framebuffer.  It can be used with display_use_framebuffer.
static __inline__ unsigned display_create_framebuffer (Capability disp_create_fb, Capability page0, Capability page1 = 0, Capability page2 = 0, unsigned w = 0, unsigned h = 0, unsigned mode = 0):
	return call_n33 (disp_create_fb, page0, page1, page2, w, h, mode)

// Use a framebuffer.  The address must have been returned from display_create_framebuffer.
// w, h and mode must match the values given at creation time.
// unuse_cb is called the next time this operation is requested.
static __inline__ void display_use_framebuffer (Capability disp_use_fb, unsigned addr, Capability unuse_cb, unsigned w = 0, unsigned h = 0, unsigned mode = 0):
	invoke_11 (disp_use_fb, unuse_cb, addr)

// Get information about the display.
static __inline__ void display_get_info (Capability disp_info):
	// TODO: Interface is to be designed.



// File system interface.
// This may not be a server, so there need not be a startup phase.  Instead, capabilities can implement certain interfaces: directory, file, stream, seekable file, mappable file.  Normal files implement at least stream or seekable file.  Directories implement directory.

enum File_request:
	FILE_INFO
	FILE_CLOSE
	FILE_COPY_HANDLE
	DIRECTORY_GET_SIZE
	DIRECTORY_GET_NAME
	DIRECTORY_GET_FILE
	DIRECTORY_GET_FILE_INFO
	DIRECTORY_CREATE_FILE
	DIRECTORY_DELETE_FILE
	FILE_STREAM_READ
	FILE_STREAM_WRITE
	FILE_SEEKABLE_READ
	FILE_SEEKABLE_WRITE
	FILE_SEEKABLE_TRUNCATE

// File interface.
// Get information about the file.
static __inline__ unsigned long long file_get_info (Capability file, unsigned type):
	return call_l02 (file, FILE_INFO, type)
// Close a file.  If this is a directory, it implicitly closes all files opened from it.
static __inline__ void file_close (Capability file):
	invoke_01 (file, FILE_CLOSE)
// Copy a file handle.  This can be useful for closing all children at once.  The new handle itself is a child of the original handle.
static __inline__ void file_copy_handle (Capability target, Capability file):
	call_c01 (file, target, FILE_COPY_HANDLE)

// Directory interface.
// Get the number of entries in this directory.
static __inline__ unsigned long long directory_get_size (Capability dir):
	return call_l01 (dir, DIRECTORY_GET_SIZE)
// Get the filename.  The return value is the size of the string, the page is filled with the string itself.
static __inline__ unsigned directory_get_name (Capability dir, unsigned long long idx, Capability page):
	return call_n13 (dir, page, DIRECTORY_GET_NAME, idx & 0xffffffff, idx >> 32)
// Get the file.
static __inline__ void directory_get_file (Capability target, Capability dir, unsigned long long idx, Capability page):
	call_c03 (dir, target, DIRECTORY_GET_FILE, idx & 0xffffffff, idx >> 32)
// Get file info.  This returns the same information as file_get_info, without opening the file.
static __inline__ unsigned long long directory_get_file_info (Capability dir, unsigned long long idx, unsigned type):
	return call_l04 (dir, DIRECTORY_GET_FILE_INFO, idx & 0xffffffff, idx >> 32, type)
// Create a new file.  After this, any index may map to a different file.
static __inline__ void directory_create_file (Capability target, Capability dir, unsigned long long idx, Capability page):
	call_c03 (dir, target, DIRECTORY_CREATE_FILE, idx & 0xffffffff, idx >> 32)
// Delete a file.  After this, any index may map to a different file.
static __inline__ void directory_delete_file (Capability target, Capability dir, unsigned long long idx, Capability page):
	call_c03 (dir, target, DIRECTORY_DELETE_FILE, idx & 0xffffffff, idx >> 32)

// Stream interface.
// Try to read size bytes.  Returns the number of bytes successfully read.  It cannot be more than PAGE_SIZE.
static __inline__ unsigned file_stream_read (Capability file, Capability page, unsigned size):
	return call_n12 (file, page, FILE_STREAM_READ, size)
// Try to write size bytes.  Returns the number of bytes successfully written.  It cannot be more than PAGE_SIZE.
static __inline__ unsigned file_stream_write (Capability file, Capability page, unsigned size):
	return call_n12 (file, page, FILE_STREAM_WRITE, size)

// Seekable file interface.
// Try to read size bytes from position idx.  Returns the number of bytes successfully read.  It cannot be more than PAGE_SIZE.
static __inline__ unsigned file_seekable_read (Capability file, Capability page, unsigned long long idx, unsigned size):
	return call_n14 (file, page, FILE_SEEKABLE_READ, idx & 0xffffffff, idx >> 32, size)
// Try to write size bytes at position idx; the file is extended with zeroes if the write is past the end.  Returns the number of bytes successfully written.  It cannot be more than PAGE_SIZE.
static __inline__ unsigned file_seekable_write (Capability file, Capability page, unsigned long long idx, unsigned size):
	return call_n14 (file, page, FILE_SEEKABLE_WRITE, idx & 0xffffffff, idx >> 32, size)
// Truncate file to size idx.  The file is extended with zeroes if it gets longer.
static __inline__ void file_seekable_truncate (Capability file, unsigned long long idx):
	call_n03 (file, FILE_SEEKABLE_TRUNCATE, idx & 0xffffffff, idx >> 32)

// Mappable file interface.
// TODO: to be designed.



// Block device interface.
// Startup: blk_get_size, blk_get_file.

// Get block size.
static __inline__ unsigned block_get_size (Capability blk_get_size):
	return call_n00 (blk_get_size)

// Get file capability.  Returns a seekable mappable non-stream file.
static __inline__ void block_get_file (Capability target, Capability blk_get_file):
	call_c00 (blk_get_file, target)



// TODO.
// Sound interface.
// Usb interfaces (port, device).
// Pointer interface.  (Only movement; buttons follow keyboard interface.)
// Network interface.
// Camera interface.
// Terminal interfaces.

#endif