flight/libraries/PyMite/vm/plat_interface.h

   1 /*
   2 # This file is Copyright 2007, 2009, 2010 Dean Hall.
   3 #
   4 # This file is part of the PyMite VM.
   5 # The PyMite VM is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU GENERAL PUBLIC LICENSE Version 2.
   7 #
   8 # The PyMite VM is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11 # A copy of the GNU GENERAL PUBLIC LICENSE Version 2
  12 # is seen in the file COPYING in this directory.
  13 */
  14
  15
  16 #ifndef __PLAT_H__
  17 #define __PLAT_H__
  18
  19
  20 /**
  21  * \file
  22  * \brief PyMite's Porting Interface
  23  */
  24
  25
  26 /**
  27  * Initializes the platform as needed by the routines
  28  * in the platform implementation file.
  29  */
  30 PmReturn_t plat_init(void);
  31
  32 /** De-initializes the platform after the VM is done running. */
  33 PmReturn_t plat_deinit(void);
  34
  35 /**
  36  * Returns the byte at the given address in memspace.
  37  *
  38  * Increments the address (just like getc and read(1))
  39  * to make image loading work (recursively).
  40  *
  41  * PORT:    fill in getByte for each memspace in the system;
  42  *          call sys_error for invalid memspaces.
  43  *
  44  * @param   memspace memory space/type
  45  * @param   paddr ptr to address
  46  * @return  byte from memory.
  47  *          paddr - points to the next byte
  48  */
  49 uint8_t plat_memGetByte(PmMemSpace_t memspace, uint8_t const **paddr);
  50
  51 /**
  52  * Receives one byte from the default connection,
  53  * usually UART0 on a target device or stdio on the desktop
  54  */
  55 PmReturn_t plat_getByte(uint8_t *b);
  56
  57
  58 /**
  59  * Sends one byte out on the default connection,
  60  * usually UART0 on a target device or stdio on the desktop
  61  */
  62 PmReturn_t plat_putByte(uint8_t b);
  63
  64
  65 /**
  66  * Gets the number of timer ticks that have passed since system start.
  67  */
  68 PmReturn_t plat_getMsTicks(uint32_t *r_ticks);
  69
  70
  71 /**
  72  * Reports an exception or other error that caused the thread to quit
  73  */
  74 void plat_reportError(PmReturn_t result);
  75
  76 #endif /* __PLAT_H__ */