osfmk/ppc/serial_io.h

   1 /*
   2  * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * @APPLE_FREE_COPYRIGHT@
  33  */
  34
  35
  36 #include <device/device_types.h>
  37 #include <mach_kdp.h>
  38
  39 /*
  40  *      Console is on the Printer Port (chip channel 0)
  41  *      Debugger is on the Modem Port (chip channel 1)
  42  */
  43
  44 #define CONSOLE_PORT    1
  45
  46 struct scc_tty {
  47         char *          t_addr;         /* device pointer */
  48         int             t_dev;          /* device number */
  49         int             t_ispeed;       /* input speed */
  50         int             t_ospeed;       /* output speed */
  51         char            t_breakc;       /* character to deliver when 'break'
  52                                            condition received */
  53         int             t_flags;        /* mode flags */
  54         int             t_state;        /* current state */
  55         int             t_line;         /* fake line discipline number,
  56                                            for old drivers - always 0 */
  57         int             t_outofband;    /* current out-of-band events */
  58         int             t_outofbandarg; /* arg to first out-of-band event */
  59         int             t_nquoted;      /* number of quoted chars in inq */
  60         int             t_hiwater;      /* baud-rate limited high water mark */
  61         int             t_lowater;      /* baud-rate limited low water mark */
  62 };
  63 typedef struct scc_tty  *scc_tty_t;
  64
  65 /*
  66  * function declarations for performing serial i/o
  67  * other functions below are declared in kern/misc_protos.h
  68  *    cnputc, cngetc, cnmaygetc
  69  */
  70
  71 void initialize_serial(caddr_t scc_phys_base, int32_t serial_baud);
  72
  73 extern int              scc_probe(int32_t serial_baud);
  74
  75 #if 0
  76 extern int              scc_open(
  77                                 dev_t           dev,
  78                                 dev_mode_t      flag,
  79                                 io_req_t        ior);
  80
  81 extern void             scc_close(
  82                                 dev_t           dev);
  83
  84 extern int              scc_read(
  85                                 dev_t           dev,
  86                                 io_req_t        ior);
  87
  88 extern io_return_t      scc_write(
  89                                 dev_t           dev,
  90                                 io_req_t        ior);
  91
  92 extern io_return_t      scc_get_status(
  93                                 dev_t                   dev,
  94                                 dev_flavor_t            flavor,
  95                                 dev_status_t            data,
  96                                 mach_msg_type_number_t  *status_count);
  97
  98 extern io_return_t      scc_set_status(
  99                                 dev_t                   dev,
 100                                 dev_flavor_t            flavor,
 101                                 dev_status_t            data,
 102                                 mach_msg_type_number_t  status_count);
 103
 104 extern boolean_t        scc_portdeath(
 105                                 dev_t           dev,
 106                                 ipc_port_t      port);
 107
 108 #endif /* 0 */
 109
 110 extern int              scc_putc(
 111                                 int                     unit,
 112                                 int                     line,
 113                                 int                     c);
 114
 115 extern int              scc_getc(
 116                                 int                     unit,
 117                                 int                     line,
 118                                 boolean_t               wait,
 119                                 boolean_t               raw);
 120
 121
 122
 123 /*
 124  * JMM - We are not really going to support this driver in SMP (barely
 125  * support it now - so just pick up the stubbed out versions.
 126  */
 127 #define DECL_FUNNEL(class,f)
 128 #define DECL_FUNNEL_VARS
 129 #define FUNNEL_INIT(f,p)
 130 #define FUNNEL_ENTER(f)
 131 #define FUNNEL_EXIT(f)
 132 #define FUNNEL_ESCAPE(f)                (1)
 133 #define FUNNEL_REENTER(f,count)
 134 #define FUNNEL_IN_USE(f)                (TRUE)
 135
 136 /*
 137  * Flags
 138  */
 139 #define TF_ODDP         0x00000002      /* get/send odd parity */
 140 #define TF_EVENP        0x00000004      /* get/send even parity */
 141 #define TF_ANYP         (TF_ODDP|TF_EVENP)
 142                                         /* get any parity/send none */
 143 #define TF_LITOUT       0x00000008      /* output all 8 bits
 144                                            otherwise, characters >= 0x80
 145                                            are time delays      XXX */
 146 #define TF_ECHO         0x00000080      /* device wants user to echo input */
 147 #define TS_MIN          0x00004000      /* buffer input chars, if possible */