build documentation

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f468e0a68fbe97513b45bacc9109b6d4
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/headers/compression.rst.txt

@@ -0,0 +1,19 @@
+.. _compression_h:
+
+compression.h
+=============
+
+.. code-block:: c
+
+    #include <compression.h>
+
+This header includes protoypes for various (de)compression routines.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: compression.h
+   :project: CE C/C++ Toolchain

_sources/headers/index.rst.txt

@@ -0,0 +1,16 @@
+.. _headers:
+
+Miscellaneous Headers
+=====================
+
+These headers contain various defines and prototypes, as well as any backwards compatibility definitions.
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    compression
+    intce
+    tice
+
+Click any of the above links to navigate to the header's documentation.

_sources/headers/intce.rst.txt

@@ -0,0 +1,25 @@
+.. _intce_h:
+
+intce.h
+=======
+
+.. code-block:: c
+
+    #include <intce.h>
+
+This header includes defines and prototypes for working with user interrupts.
+
+.. warning::
+
+    As of hardware revision I, user interrupt vectors are no longer supported.
+    Some functions will no longer work on the newer hardware, and are labeled as such.
+    Feel free to send TI a strongly worded email about this limitation.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: intce.h
+   :project: CE C/C++ Toolchain

_sources/headers/sys/basicusb.rst.txt

@@ -0,0 +1,20 @@
+.. _basicusb_h:
+
+sys/basicusb.h
+==============
+
+.. code-block:: c
+
+    #include <sys/basicusb.h>
+
+Proper support for USB devices is in development.
+This header does not provide that.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: sys/basicusb.h
+   :project: CE C/C++ Toolchain

_sources/headers/sys/index.rst.txt

@@ -0,0 +1,19 @@
+.. _sys:
+
+CE Hardware Headers
+===================
+
+These headers are specific to the calculator's hardware, and contain various defines and prototypes.
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    basicusb
+    lcd
+    power
+    rtc
+    timers
+    util
+
+Click any of the above links to navigate to the header's documentation.

_sources/headers/sys/lcd.rst.txt

@@ -0,0 +1,19 @@
+.. _lcd_h:
+
+sys/lcd.h
+=========
+
+.. code-block:: c
+
+    #include <sys/lcd.h>
+
+This header includes defines for the PL111 LCD controller used in the CE.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: sys/lcd.h
+   :project: CE C/C++ Toolchain

_sources/headers/sys/power.rst.txt

@@ -0,0 +1,20 @@
+.. _power_h:
+
+sys/power.h
+===========
+
+.. code-block:: c
+
+    #include <sys/power.h>
+
+Power control hardware registers are not directly accessible.
+However, this header provides access to OS routines that perform control functions.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: sys/power.h
+   :project: CE C/C++ Toolchain

_sources/headers/sys/rtc.rst.txt

@@ -0,0 +1,20 @@
+.. _rtc_h:
+
+sys/rtc.h
+=========
+
+.. code-block:: c
+
+    #include <sys/rtc.h>
+
+This header includes defines for the Real-Time Clock (RTC) used in the CE.
+The toolchain allows both direct access to the hardware registers, and using TI's helper routines.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: sys/rtc.h
+   :project: CE C/C++ Toolchain

_sources/headers/sys/timers.rst.txt

@@ -0,0 +1,30 @@
+.. _timers_h:
+
+sys/timers.h
+============
+
+.. code-block:: c
+
+    #include <sys/timers.h>
+
+This header includes defines for the CE's 3 hardware timers.
+It is discouraged from directly modifying the timers themseleves, and instead use the standard C `clock()` fuction.
+This is because the toolchain uses the timers in the following way:
+
+  * Timer 1 is used for `clock()` and related functions like `sleep()`.
+  * Timer 2 is used by the :ref:`usbdrvce library <usbdrvce_h>`.
+  * Timer 3 is used by the TI-OS USB stack and shouldn't be touched in most every case.
+
+Directly manipulating the hardware timers may cause the above functions and/or libraries to not work correctly.
+However, for example if you aren't using usbdrvce it is possible to use Timer 2 in your application.
+
+There are two possible timing ("clock") sources: a 32768 Hz crystal with similar accuracy to the clock found in any smartphone or wristwatch, and the CPU's main 48 MHz clock with likely much inferior accuracy.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: sys/timers.h
+   :project: CE C/C++ Toolchain

_sources/headers/sys/util.rst.txt

@@ -0,0 +1,19 @@
+.. _util_h:
+
+sys/util.h
+==========
+
+.. code-block:: c
+
+    #include <sys/util.h>
+
+This header includes defines for miscellaneous CE-specific things.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: sys/util.h
+   :project: CE C/C++ Toolchain

_sources/headers/ti/debug.rst.txt

@@ -0,0 +1,20 @@
+.. _debug_h:
+
+ti/debug.h
+==========
+
+.. code-block:: c
+
+    #include <ti/debug.h>
+
+TI has implemented debugging differently than CEmu does.
+This header provides access to TI's debugging API, which is not useful if you don't have their tools.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: ti/debug.h
+   :project: CE C/C++ Toolchain

_sources/headers/ti/error.rst.txt

@@ -0,0 +1,35 @@
+.. _error_h:
+
+ti/error.h
+==========
+
+.. code-block:: c
+
+    #include <ti/error.h>
+
+Exceptions in languages like Python provide a structured way of handling rare error conditions.
+TI calls their implementation of this idea error handlers.
+
+When the OS encounters an unsusal condition such as divide-by-zero or out-of-memory, it looks for an active error handler.
+If no active error handlers exist, the OS will display the :code:`ERR:` screen.
+If an active error handler does exist, it gets control instead of showing the :code:`ERR:` screen.
+
+Unlike exception handlers, TI's error handlers do not differentiate between error codes; the same error handler is called for all errors.
+However, error handlers do support nesting.
+If an handler decides that it can't handle an error, it can rethrow it.
+
+.. warning::
+
+    When a TI error handler is invoked, C++ destructors **are not** run *even if the handler is outside the current scope!*
+    Therefore, you must be very careful with object creation while an error handler is active.
+
+Similarly, although the toolchain supports C++, it does *not* support C++ exceptions, and TI error handlers are not a substitute for C++ exceptions.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: ti/error.h
+   :project: CE C/C++ Toolchain

_sources/headers/ti/flags.rst.txt

@@ -0,0 +1,21 @@
+.. _flags_h:
+
+ti/flags.h
+==========
+
+.. code-block:: c
+
+    #include <ti/flags.h>
+
+TI's operating system has a lot of simple states it keeps track of, such as whether 2nd has been pressed.
+These settings are stored in a structure called the system flags, and can be accessed quickly by the OS.
+Most of these flags are useful only if you need to access OS mathematical or UI functions.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: ti/flags.h
+   :project: CE C/C++ Toolchain

_sources/headers/ti/getcsc.rst.txt

@@ -0,0 +1,53 @@
+.. _getcsc_h:
+
+ti/getcsc.h
+===========
+
+.. code-block:: c
+
+    #include <ti/getcsc.h>
+
+Naturally, TI's operating system also has its own keyboard driver. This header is used to get the CSCs (current scan codes) from the keyboard driver.
+You can easily use this header instead of the :code:`keypadc` library, and is particularly suited to non-game programs.
+
+The OS's interrupt handler handles the keyboard driver and caches a scancode when it detects a key press.
+You can use this scancode directly without any translation of 2nd and alpha through the :code:`os_GetCSC` function.
+
+
+TI-83 Premium CE
+----------------
+
+Some keys on the TI-83 Premium CE are labeled differently, and some have completely different functions.
+For convenience, there are additional equates for the TI-83 Premium CE names.
+In the table below, the five keys with different functions are **emphasized.**
+
++---------------+-------------------+-----------------------+-------------------------+
+| TI-84 Plus CE | Equate            | TI-83 Premium CE      | Equate                  |
++===============+===================+=======================+=========================+
+| Y=            | :code:`sk_Yequ`   | f(x)                  | :code:`sk_Fx`           |
++---------------+-------------------+-----------------------+-------------------------+
+| Window        | :code:`sk_Window` | Fenetre               | :code:`sk_Fenetre`      |
++---------------+-------------------+-----------------------+-------------------------+
+| Del           | :code:`sk_Del`    | Suppr                 | :code:`sk_Suppr`        |
++---------------+-------------------+-----------------------+-------------------------+
+| **Apps**      | :code:`sk_Apps`   | **Matrice**           | :code:`sk_Matrice`      |
++---------------+-------------------+-----------------------+-------------------------+
+| Clear         | :code:`sk_Clear`  | Annul                 | :code:`sk_Annul`        |
++---------------+-------------------+-----------------------+-------------------------+
+| **x^-1**      | :code:`sk_Recip`  | **<>**                | :code:`sk_TglExact`     |
++---------------+-------------------+-----------------------+-------------------------+
+| **Sin**       | :code:`sk_Sin`    | **Trig**              | :code:`sk_Trig`         |
++---------------+-------------------+-----------------------+-------------------------+
+| **Cos**       | :code:`sk_Cos`    | **Resol**             | :code:`sk_Resol`        |
++---------------+-------------------+-----------------------+-------------------------+
+| **Tan**       | :code:`sk_Tan`    | **Fraction template** | :code:`sk_Frac`         |
++---------------+-------------------+-----------------------+-------------------------+
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: ti/getcsc.h
+   :project: CE C/C++ Toolchain

_sources/headers/ti/getkey.rst.txt

@@ -0,0 +1,26 @@
+.. _getkey_h:
+
+ti/getkey.h
+===========
+
+.. code-block:: c
+
+    #include <ti/getkey.h>
+
+For programs that interact with the OS's user interface, you may want to use processed keystrokes instead of raw scancodes.
+The :code:`os_GetKey` routine handles 2nd and alpha presses, and can even show menus.
+
+TI-83 Premium CE
+----------------
+
+No research has been done on how the TI-83 Premium CE is different here.
+However, you should be aware that on the TI-83 Premium CE, :code:`os_GetKey` may return values not included in this list.
+
+.. contents:: :local:
+   :depth: 3
+
+API Documentation
+-----------------
+
+.. doxygenfile:: ti/getkey.h
+   :project: CE C/C++ Toolchain