Commit 83dde269 authored by frtabu's avatar frtabu

fix broken links

parent f08ef335
...@@ -4,4 +4,4 @@ The oai shared library loader is implemented in two source files, located in [co ...@@ -4,4 +4,4 @@ The oai shared library loader is implemented in two source files, located in [co
1. [load_module_shlib.c](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.c) contains the loader implementation 1. [load_module_shlib.c](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.c) contains the loader implementation
1. [load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.h) is the loader include file containing both private and public data type definitions. It also contain API prototypes. 1. [load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.h) is the loader include file containing both private and public data type definitions. It also contain API prototypes.
[loader home page](loader) [loader home page](..loader.md)
\ No newline at end of file \ No newline at end of file
...@@ -5,13 +5,13 @@ The configuration module objectives are ...@@ -5,13 +5,13 @@ The configuration module objectives are
As a developer you may need to look at these sections: As a developer you may need to look at these sections:
* [loading a shared library](loader/devusage/loading) * [loading a shared library](devusage/loading.md)
* [loader API](loader/devusage/api) * [loader API](devusage/api.md)
* [loader public structures](loader/devusage/struct) * [loader public structures](devusage/struct.md)
Loader usage examples can be found in oai sources: Loader usage examples can be found in oai sources:
* device and transport initialization code: [function `load_lib` in *targets/ARCH/COMMON/__common_lib.c__* ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/targets/ARCH/COMMON/common_lib.c#L91) * device and transport initialization code: [function `load_lib` in *targets/ARCH/COMMON/__common_lib.c__* ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/targets/ARCH/COMMON/common_lib.c#L91)
* turbo encoder and decoder initialization: [function `load_codinglib`in *openair1/PHY/CODING/__coding_load.c__*](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/CODING/coding_load.c#L113) * turbo encoder and decoder initialization: [function `load_codinglib`in *openair1/PHY/CODING/__coding_load.c__*](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/CODING/coding_load.c#L113)
[loader home page](loader) [loader home page](../loader.md)
...@@ -16,5 +16,5 @@ void * get_shlibmodule_fptr(char *modname, char *fname) ...@@ -16,5 +16,5 @@ void * get_shlibmodule_fptr(char *modname, char *fname)
``` ```
Returns a pointer to the symbol `fname`, defined in module `modname`, or `NULL` if the symbol is not found. Returns a pointer to the symbol `fname`, defined in module `modname`, or `NULL` if the symbol is not found.
[loader home page](loader) [loader home page](../loader.md)
[loader developer home page](loader/devusage) [loader developer home page](../devusage.md)
\ No newline at end of file \ No newline at end of file
...@@ -52,5 +52,5 @@ if (f2 != NULL) { ...@@ -52,5 +52,5 @@ if (f2 != NULL) {
``` ```
When loading a shared library the loader looks for a symbol named `< module name > _autoinit` and, if it finds it, calls it. The `autoinit` function is called without any argument and the returned value, if any, is not tested. When loading a shared library the loader looks for a symbol named `< module name > _autoinit` and, if it finds it, calls it. The `autoinit` function is called without any argument and the returned value, if any, is not tested.
[loader home page](loader) [loader home page](../loader.md)
[loader developer home page](loader/devusage) [loader developer home page](../../loader/devusage.md)
\ No newline at end of file \ No newline at end of file
...@@ -6,5 +6,5 @@ It is defined in include file [ common/util/load_module_shlib.h ](https://gitlab ...@@ -6,5 +6,5 @@ It is defined in include file [ common/util/load_module_shlib.h ](https://gitlab
| `fname` | symbol name, is passed to the [`dlsym`](http://man7.org/linux/man-pages/man3/dlsym.3.html) system call performed by the loader to get a pointer to the symbol | I | | `fname` | symbol name, is passed to the [`dlsym`](http://man7.org/linux/man-pages/man3/dlsym.3.html) system call performed by the loader to get a pointer to the symbol | I |
| `fptr` | pointer to the symbol name, set by the loader. `fptr` is defined as a `int (*fptr)(void)` function type | O | | `fptr` | pointer to the symbol name, set by the loader. `fptr` is defined as a `int (*fptr)(void)` function type | O |
[loader home page](loader) [loader home page](../..loader.md)
[loader developer home page](loader/devusage) [loader developer home page](../devusage.md)
\ No newline at end of file \ No newline at end of file
...@@ -6,7 +6,7 @@ Shared library full names are built by the loader using the format: ...@@ -6,7 +6,7 @@ Shared library full names are built by the loader using the format:
1. the < *module version* > and < *path* > optional parameters, are defined at run-time, depending on the configuration. 1. the < *module version* > and < *path* > optional parameters, are defined at run-time, depending on the configuration.
## loader parameters ## loader parameters
The loader is using the [configuration module](config), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters. The loader is using the [configuration module](../../../config/DOCconfig.md), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters.
### Global loader parameters ### Global loader parameters
| name | type | default | description | | name | type | default | description |
|:---:|:---:|:---:|:----| |:---:|:---:|:---:|:----|
...@@ -47,4 +47,4 @@ With this latest example, nn the softmodem logs, you can check that the right de ...@@ -47,4 +47,4 @@ With this latest example, nn the softmodem logs, you can check that the right de
``` ```
[loader home page](loader) [loader home page](..loader.md)
\ No newline at end of file \ No newline at end of file
...@@ -92,7 +92,7 @@ int add_telnetcmd(char *modulename, telnetshell_vardef_t *var, telnetshell_cmdde ...@@ -92,7 +92,7 @@ int add_telnetcmd(char *modulename, telnetshell_vardef_t *var, telnetshell_cmdde
Add a command and the `cmd` list of sub-commands to the telnet server. After a successful call to `add_telnetcmd` function, the telnet server calls the function defined for each sub-commands in the null terminated `cmd` array, when the character string received from the telnet client matches the command and sub-command strings. Add a command and the `cmd` list of sub-commands to the telnet server. After a successful call to `add_telnetcmd` function, the telnet server calls the function defined for each sub-commands in the null terminated `cmd` array, when the character string received from the telnet client matches the command and sub-command strings.
Also adds the list of variables described in the `var` array to the list of variable which can be set and read. Also adds the list of variables described in the `var` array to the list of variable which can be set and read.
The function returns -1 if one argument is NULL. The function returns -1 if one argument is NULL.
The telnet server is dynamically loaded, to use the `add_telnetcmd` function, the shared library loader API should be used to check the availability of the telnet server and retrieve it's address, as shown in [the example at the top of this page](telnetaddcmd#code-example-of-adding-a-command-to-the-telnet-server). The telnet server is dynamically loaded, to use the `add_telnetcmd` function, the shared library loader API should be used to check the availability of the telnet server and retrieve it's address, as shown in [the example at the top of this page](telnetaddcmd.md#code-example-of-adding-a-command-to-the-telnet-server).
# telnet server public data types # telnet server public data types
## `telnetshell_vardef_t`structure ## `telnetshell_vardef_t`structure
...@@ -113,4 +113,4 @@ The telnet server is dynamically loaded, to use the `add_telnetcmd` function, t ...@@ -113,4 +113,4 @@ The telnet server is dynamically loaded, to use the `add_telnetcmd` function, t
| `helpstr` | `char[TELNET_HELPSTR_SIZE]` | character string to print when the elp`command is received from the telnet client | | `helpstr` | `char[TELNET_HELPSTR_SIZE]` | character string to print when the elp`command is received from the telnet client |
| `cmdfunc` | `cmdfunc_t` | pointer to the function implementing the `cmdname` sub command. | | `cmdfunc` | `cmdfunc_t` | pointer to the function implementing the `cmdname` sub command. |
[oai telnet server home](telnetsrv) [oai telnet server home](telnetsrv.md)
\ No newline at end of file \ No newline at end of file
...@@ -18,4 +18,4 @@ telnet server source files are located in [common/utils/telnetsrv](https://gitla ...@@ -18,4 +18,4 @@ telnet server source files are located in [common/utils/telnetsrv](https://gitla
1. `telnetsrv\_\<XXX\>.h`: include file for the implementation of XXX CLI command. Usually included only in the corresponding `.c`file 1. `telnetsrv\_\<XXX\>.h`: include file for the implementation of XXX CLI command. Usually included only in the corresponding `.c`file
1. [telnetsrv_CMakeLists.txt](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/telnetsrv/telnetsrv_CMakeLists.txt): CMakelists file containing the cmake instructions to build the telnet server. this file is included in the [global oai CMakelists](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/cmake_targets/CMakeLists.txt). 1. [telnetsrv_CMakeLists.txt](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/telnetsrv/telnetsrv_CMakeLists.txt): CMakelists file containing the cmake instructions to build the telnet server. this file is included in the [global oai CMakelists](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/cmake_targets/CMakeLists.txt).
[oai telnet server home](telnetsrv) [oai telnet server home](telnetsrv.md)
\ No newline at end of file \ No newline at end of file
...@@ -17,5 +17,5 @@ telnet, loopc = 100 ...@@ -17,5 +17,5 @@ telnet, loopc = 100
softmodem> softmodem>
``` ```
[oai telnetserver home](telnetsrv) [oai telnetserver home](telnetsrv.md)
[oai telnetserver usage home](telnetusage) [oai telnetserver usage home](telnetusage.md)
\ No newline at end of file \ No newline at end of file
...@@ -53,5 +53,5 @@ softmodem> ...@@ -53,5 +53,5 @@ softmodem>
``` ```
[oai telnetserver home](telnetsrv) [oai telnetserver home](telnetsrv.md)
[oai telnetserver usage home](telnetusage) [oai telnetserver usage home](telnetusage.md)
\ No newline at end of file \ No newline at end of file
...@@ -40,5 +40,5 @@ softmodem> ...@@ -40,5 +40,5 @@ softmodem>
``` ```
[oai telnetserver home](telnetsrv) [oai telnetserver home](telnetsrv.md)
[oai telnetserver usage home](telnetusage) [oai telnetserver usage home](telnetusage.md)
\ No newline at end of file \ No newline at end of file
...@@ -43,5 +43,5 @@ softmodem> loader show modules ...@@ -43,5 +43,5 @@ softmodem> loader show modules
softmodem> softmodem>
``` ```
[oai telnetserver home](telnetsrv) [oai telnetserver home](telnetsrv.md)
[oai telnetserver usage home](telnetusage) [oai telnetserver usage home](telnetusage.md)
\ No newline at end of file \ No newline at end of file
The log command can be used to get the status of the log parameters and to dynamically modify these parameters. The log command has its own [help](telnethelp#oai-telnet-server-specific-commands-help) The log command can be used to get the status of the log parameters and to dynamically modify these parameters. The log command has its own [help](telnethelp.md#oai-telnet-server-specific-commands-help)
```bash ```bash
softmodem> softmodem log disable 0-35 softmodem> softmodem log disable 0-35
log level/verbosity comp 0 PHY set to info / medium (disabled) log level/verbosity comp 0 PHY set to info / medium (disabled)
...@@ -91,5 +91,5 @@ softmodem> exit ...@@ -91,5 +91,5 @@ softmodem> exit
Connection closed by foreign host. Connection closed by foreign host.
``` ```
[oai telnetserver home](telnetsrv) [oai telnetserver home](telnetsrv.md)
[oai telnetserver usage home](telnetusage) [oai telnetserver usage home](telnetusage.md)
\ No newline at end of file \ No newline at end of file
...@@ -36,5 +36,5 @@ softmodem> loop softmodem show thread ...@@ -36,5 +36,5 @@ softmodem> loop softmodem show thread
``` ```
A **_loop_** command can be interrupted by pressing the **_enter_** key till getting the prompt. A **_loop_** command can be interrupted by pressing the **_enter_** key till getting the prompt.
[oai telnetserver home](telnetsrv) [oai telnetserver home](telnetsrv.md)
[oai telnetserver usage home](telnetusage) [oai telnetserver usage home](telnetusage.md)
\ No newline at end of file \ No newline at end of file
...@@ -4,4 +4,4 @@ The oai embedded telnet server is an optional monitoring and debugging tool. It ...@@ -4,4 +4,4 @@ The oai embedded telnet server is an optional monitoring and debugging tool. It
* [Adding commands to the oai telnet server](telnetaddcmd.md) * [Adding commands to the oai telnet server](telnetaddcmd.md)
* [telnet server architecture ](telnetarch.md) * [telnet server architecture ](telnetarch.md)
[oai Wikis home](home) [oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home)
\ No newline at end of file \ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment