include/rtems/umon.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  * umon.h - RTEMS specific interface to MicroMonitor.
0005  *
0006  *  COPYRIGHT (c) 1989-2009.
0007  *  On-Line Applications Research Corporation (OAR).
0008  *
0009  *  Modified by Fernando Nicodemos <fgnicodemos@terra.com.br>
0010  *  from NCB - Sistemas Embarcados Ltda. (Brazil)
0011  *
0012  * Redistribution and use in source and binary forms, with or without
0013  * modification, are permitted provided that the following conditions
0014  * are met:
0015  * 1. Redistributions of source code must retain the above copyright
0016  *    notice, this list of conditions and the following disclaimer.
0017  * 2. Redistributions in binary form must reproduce the above copyright
0018  *    notice, this list of conditions and the following disclaimer in the
0019  *    documentation and/or other materials provided with the distribution.
0020  *
0021  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0022  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0023  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0024  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0025  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0026  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0027  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0028  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0029  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0030  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0031  * POSSIBILITY OF SUCH DAMAGE.
0032 */
0033
0034 #ifndef __rtems_umon_h
0035 #define __rtems_umon_h
0036
0037 #include <umon/monlib.h>
0038
0039 #ifdef __cplusplus
0040 extern "C" {
0041 #endif
0042
0043 /**
0044  * @brief Connect RTEMS Application to MicroMonitor
0045  *
0046  * RTEMS uMonitor wrapper for monConnect().  This will deal with the
0047  * getting MONCOMPTR as well as providing the locking routines.
0048  */
0049 void rtems_umon_connect(void);
0050
0051 /**
0052  * @brief Obtain BSP specific pointer to MicroMonitor
0053  *
0054  * BSP specific routine to help when calling monConnect().  This
0055  * returns the value known to uMon as MONCOMPTR.
0056  *
0057  * @return This method returns the address of the base area of MicroMonitor.
0058  */
0059 void *rtems_bsp_get_umon_monptr(void);
0060
0061 /**
0062  * @brief Initialize the TFS-RTEMS file system
0063  *
0064  * This method initializes and mounts the TFS-RTEMS file system.
0065  *
0066  * @param[in] path is the mount point
0067  *
0068  * @return This method returns 0 on success.
0069  */
0070 int rtems_initialize_tfs_filesystem(
0071   const char *path
0072 );
0073
0074 /**
0075  * @brief Read from MicroMonitor Port
0076  *
0077  * This method reads a character from the MicroMonitor console.
0078  *
0079  * @return This method returns a character.
0080  */
0081 int umoncons_poll_read(int minor);
0082
0083 #ifdef __cplusplus
0084 }
0085 #endif
0086
0087 #endif /* __rtems_umon_h */