IPC@CHIP® RTOS-LNX – API Documentation
The name @CHIP-RTOS-LNX is used as the term for the operating system of the IPC@CHIP® SC1x8 and SC1x5. The main difference between this new system and the older @CHIP-RTOS and @CHIP-RTOS-PPC systems is that it is no longer based on a proprietary real-time kernel. Instead the @CHIP-RTOS-LNX now uses the Linux kernel.
The main motivation to use the Linux kernel for this new operation system was to benefit from the Linux kernel development and other open-source projects. Using the Linux kernel as a hardware abstraction makes it easier to port the operating system to new hardware platforms. Porting of other open-source software also becomes much easier when using a POSIX compatible system.
The aim of the @CHIP-RTOS-LNX is to hide the complexities of a Linux system from the user. The goal is that it will look like the older @CHIP-RTOS operating systems. Its aim is to provide a high level of compatibility to the APIs of the SC1x, SC2x, SC1x3 and SC2x3 computers.
For an overview of the provided features and the general architecture of the operating system see the @CHIP-RTOS-LNX architecture.
The operating system is preinstalled on the IPC@CHIP®. It is able to execute multiple application programs simultaneous. Each program is a discrete executable that can be transfered to the file system of the IPC@CHIP® over FTP. Each program runs as a task of the RTOS kernel. Within each application program additional tasks can be created. Beyond the normal RTOS services, like mananging task and using semaphores, etc., the operating system provides a complete TCP/IP stack and integrated servers, like Telnet, FTP(S) and HTTP(S).
Beck offers a development environment for C/C++ programming, the so-called ONE-Workbench. This documentation describes the Application Programming Interface (API), the system configuration over the CHIP.INI file and the available shell commands of the @CHIP-RTOS-LNX. It should be used as a reference manual for IPC@CHIP® SC1x8 and SC1x5 application programmers. For a better understanding of this manual the reader should have some experience in programming embedded applications.
The document explains in detail how to call every provided function of the @CHIP-RTOS-LNX from user application programs. The API of the @CHIP-RTOS-LNX is structured into different sections (e.g. RTOS API, TCP/IP API, etc.). The processor hardware resources like CAN, SPI, I2C, GPIOs, Timers, etc. are also covered by API functions, so the application programmer has not to deal with processor register values. All API sections are listed as HTML-links on the main index page of this document.
The API is integrated as a C-Library (CLIB) into the ONE-Workbench development environment. The C-Library provides an efficient interface to the set of underlying @CHIP-RTOS-LNX services. A collection of example programs is also provided, which demonstrate the usage of the API.
You will find some useful general notes about programming @CHIP-RTOS-LNX applications for the IPC@CHIP® under Programming notes.
For some necessary knowledge about hardware details of the IPC@CHIP®, see the hardware manuals available from the download area of www.beck-ipc.com.