Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 1.05.00

The code and documentation of the µC/TELNETs module are organized in a directory structure according to “AN 2002, µC/OS-II Directory Structure.” Specifically, the files may be found in the following directories:

\Micrium\Software\uC-TELNETs

This is the main directory for µC/TELNETs

\Micrium\Software\uC-TELNETs\Doc

This directory contains all µC/TELNETs documentation files, including this user’s manual.

\Micrium\Software\uC-TELNETs\Cfg\Template

This directory contains a template of µC/TELNETs configuration.

\Micrium\Software\uC-TELNETs\Source

This directory contains the µC/TELNETs source code. This protocol is implemented in two OS independent files:

telnet-s.c
telnet-s.h

Note that the ‘-s’ after ‘telnet’ stands for server and thus contains ‘server’ side code.

\Micrium\Software\uC-TELNETs\OS\uCOS-II

This section discusses the modules available for μC/TELNETs, and how they all fit together. A Windows®-based development platform is assumed. The directories and files make references to typical Windows-type directory structures. However, since μC/TELNETs is available in source form, it can also be used with any ANSI-C compatible compiler/linker and any Operating System.

Below is a summary of all directories and files involved in the µC/TELNETs module. The ‘<- Cfg’ on the far right indicates that these files are typically copied into the application (i.e., project) directory and edited based on project requirements. The ‘<- Public API’ on the far right indicates that where are located the public API which should be used by the application.

 

Code Block
\Micrium
    \Software
        \uC-TELNETs
            \Cfg
                \Template
                    \telnet-s_cfg.h                     <- Cfg
            \OS
                \uCOS-II
                    \iperf_os.c                    
                \uCOS-III
            \Cmd
                \telnet-s_cmd.c
                \telnet-s_cmd.h
            \Examples
                \telnet-s_init.c
            \Source
                \telnet-s.c
                \telnet-s.h                             <- Public 

...

This is where operating system (OS) dependent code is located. µC/TELNETs is distributed with ports for µC/OS-II and µC/OS-III. Note that it would be possible to use µC/TELNETs with other operating systems by developing appropriate telnet-s_os.* implementation files.

Required modules

µC/TELNETs requires the µC/CPU, µC/LIB, and µC/TCP-IP modules. If the network security manager is to be used, a security layer module (i.e µC/SSL) is required. Please refer to the µC/TELNETs release notes document for required version information.

...

API

\Micrium

Contains all software components and projects provided by Micrium.

\Software

This sub-directory contains all software components and projects.

\uC-TELNETs

This is the main µC/TELNETs directory.

Source code

\Source

This is the directory that contains all the CPU and RTOS independent source code files,

Commands add-on using μC/Shell

\Cmd

This is the directory that contains an implementation of µC/TELNETs using µC/Shell. Any command loaded in µC/Shell can be launch trough the TELNET terminal.

OS implementation code

\OS

This is the directory that contains the implementation for different OS to the TELNET server.

Examples

\Examples

This is the directory that contains all TELNET server examples