dev/serial/legacy-console.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup Console
0007  *
0008  * @brief  Extension of the generic libchip console driver shell
0009  */
0010
0011 /*
0012  *  COPYRIGHT (c) 1989-2011, 2016.
0013  *  On-Line Applications Research Corporation (OAR).
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _PC386_CONSOLE_PRIVATE_h
0038 #define _PC386_CONSOLE_PRIVATE_h
0039
0040 #include <rtems.h>
0041
0042 #include <libchip/serial.h>
0043
0044 #ifdef __cplusplus
0045 extern "C" {
0046 #endif
0047
0048 extern rtems_device_minor_number  BSPPrintkPort;
0049
0050 /**
0051  *  @brief
0052  *
0053  *  This function is the ioctl() support for a VGA buffer driver.
0054  *
0055  *  @return This method returns 0 on success.
0056  */
0057 int vt_ioctl(
0058   unsigned int cmd,
0059   unsigned long arg
0060 );
0061
0062 /**
0063  *  @brief console_find_console_entry
0064  *
0065  *  This method is used to search the console entries for a
0066  *  specific device entry and return it. If match is NULL the
0067  *  minor number provided is matched.
0068  */
0069 console_tbl* console_find_console_entry(
0070   const char                *match,
0071   size_t                     length,
0072   rtems_device_minor_number *match_minor
0073 );
0074
0075 /**
0076  *  @brief console_initialize_data
0077  *
0078  *  This must be called before dynamic registration of devices can occur.
0079  *  It is normally called as a side-effect of @a console_initialize() but
0080  *  if a probe and dynamic registration occurs before that, then this method
0081  *  should be explicitly invoked.
0082  */
0083 void console_initialize_data(void);
0084
0085 /**
0086  *  @brief console_register_devices
0087  *
0088  *  This function expands the console table to include previous
0089  *  ports and the array of new ports specified.
0090  *
0091  *  @param[in] new_ports specifies an array of new ports to register
0092  *  @param[in] number_of_ports specifies the number of elements
0093  *         in the new_ports array
0094  *
0095  */
0096 void console_register_devices(
0097   console_tbl *new_ports,
0098   size_t       number_of_ports
0099 );
0100
0101 #ifdef __cplusplus
0102 }
0103 #endif
0104
0105 /**@}*/
0106
0107 #endif
0108 /* end of include file */