aboutsummaryrefslogtreecommitdiff
path: root/supervisor/port.h
diff options
context:
space:
mode:
Diffstat (limited to 'supervisor/port.h')
-rw-r--r--supervisor/port.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/supervisor/port.h b/supervisor/port.h
new file mode 100644
index 000000000..465b5a27d
--- /dev/null
+++ b/supervisor/port.h
@@ -0,0 +1,56 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016-2017 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_SUPERVISOR_PORT_H
+#define MICROPY_INCLUDED_SUPERVISOR_PORT_H
+
+#include "py/mpconfig.h"
+
+#ifndef PORT_HEAP_SIZE
+#error "Please define PORT_HEAP_SIZE to specify heap size in bytes."
+#endif
+
+typedef enum {
+ NO_SAFE_MODE = 0,
+ BROWNOUT,
+ HARD_CRASH,
+ USER_SAFE_MODE,
+} safe_mode_t;
+
+// Provided by the linker;
+extern uint32_t _ezero;
+
+// This file defines core methods that must be implemented by a port.
+extern uint32_t _estack;
+
+// Stored at the end of the bss section (which includes the heap).
+extern uint32_t _ebss;
+
+safe_mode_t port_init(void);
+void reset_port(void);
+void reset_board(void);
+
+#endif // MICROPY_INCLUDED_SUPERVISOR_PORT_H