123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158 |
- /****************************************************************************
- * include/nuttx/module.h
- *
- * Copyright (C) 2015, 2017 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <gnutt@nuttx.org>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- * 3. Neither the name NuttX nor the names of its contributors may be
- * used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
- * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- ****************************************************************************/
- #ifndef __INCLUDE_NUTTX_MODULE_H
- #define __INCLUDE_NUTTX_MODULE_H
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <nuttx/config.h>
- #include <sys/types.h>
- /****************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
- #undef EXTERN
- #if defined(__cplusplus)
- #define EXTERN extern "C"
- extern "C"
- {
- #else
- #define EXTERN extern
- #endif
- /****************************************************************************
- * Name: insmod
- *
- * Description:
- * Verify that the file is an ELF module binary and, if so, load the
- * module into kernel memory and initialize it for use.
- *
- * NOTE: modlib_setsymtab had to have been called in board-specific OS logic
- * prior to calling this function from application logic (perhaps via
- * boardctl(BOARDIOC_OS_SYMTAB). Otherwise, insmod will be unable to
- * resolve symbols in the OS module.
- *
- * Input Parameters:
- *
- * filename - Full path to the module binary to be loaded
- * modname - The name that can be used to refer to the module after
- * it has been loaded.
- *
- * Returned Value:
- * A non-NULL module handle that can be used on subsequent calls to other
- * module interfaces is returned on success. If insmod() was unable to
- * load the module insmod() will return a NULL handle and the errno
- * variable will be set appropriately.
- *
- ****************************************************************************/
- FAR void *insmod(FAR const char *filename, FAR const char *modname);
- /****************************************************************************
- * Name: rmmod
- *
- * Description:
- * Remove a previously installed module from memory.
- *
- * Input Parameters:
- * handle - The module handler previously returned by insmod().
- *
- * Returned Value:
- * Zero (OK) on success. On any failure, -1 (ERROR) is returned the
- * errno value is set appropriately.
- *
- ****************************************************************************/
- int rmmod(FAR void *handle);
- /****************************************************************************
- * Name: modsym
- *
- * Description:
- * modsym() returns the address of a symbol defined within the object that
- * was previously made accessible through a insmod() call. handle is the
- * value returned from a call to insmod() (and which has not since been
- * released via a call to rmmod()), name is the symbol's name as a
- * character string.
- *
- * The returned symbol address will remain valid until rmmod() is called.
- *
- * Input Parameters:
- * handle - The opaque, non-NULL value returned by a previous successful
- * call to insmod().
- * name - A pointer to the symbol name string.
- *
- * Returned Value:
- * The address associated with the symbol is returned on success.
- * If handle does not refer to a valid module opened by insmod(), or if
- * the named symbol cannot be found within any of the objects associated
- * with handle, modsym() will return NULL and the errno variable will be
- * set appropriately.
- *
- ****************************************************************************/
- FAR const void *modsym(FAR void *handle, FAR const char *name);
- /****************************************************************************
- * Name: modhandle
- *
- * Description:
- * modhandle() returns the module handle for the installed module with the
- * provided name. A secondary use of this function is to determine if a
- * module has been loaded or not.
- *
- * Input Parameters:
- * name - A pointer to the module name string.
- *
- * Returned Value:
- * The non-NULL module handle previously returned by insmod() is returned
- * on success. If no module with that name is installed, modhandle() will
- * return a NULL handle and the errno variable will be set appropriately.
- *
- ****************************************************************************/
- FAR void *modhandle(FAR const char *name);
- #undef EXTERN
- #if defined(__cplusplus)
- }
- #endif
- #endif /* __INCLUDE_NUTTX_MODULE_H */
|