LXR linux/include/linux/serial

   1/*
   2 *  linux/include/linux/serial_8250.h
   3 *
   4 *  Copyright (C) 2004 Russell King
   5 *
   6 * This program is free software; you can redistribute it and/or modify
   7 * it under the terms of the GNU General Public License as published by
   8 * the Free Software Foundation; either version 2 of the License, or
   9 * (at your option) any later version.
  10 */
  11#ifndef _LINUX_SERIAL_8250_H
  12#define _LINUX_SERIAL_8250_H
  13
  14#include <linux/serial_core.h>
  15#include <linux/platform_device.h>
  16
  17/*
  18 * This is the platform device platform_data structure
  19 */
  20struct plat_serial8250_port {
  21        unsigned long   iobase;         /* io base address */
  22        void __iomem    *membase;       /* ioremap cookie or NULL */
  23        resource_size_t mapbase;        /* resource base */
  24        unsigned int    irq;            /* interrupt number */
  25        unsigned long   irqflags;       /* request_irq flags */
  26        unsigned int    uartclk;        /* UART clock rate */
  27        void            *private_data;
  28        unsigned char   regshift;       /* register shift */
  29        unsigned char   iotype;         /* UPIO_* */
  30        unsigned char   hub6;
  31        upf_t           flags;          /* UPF_* flags */
  32        unsigned int    type;           /* If UPF_FIXED_TYPE */
  33        unsigned int    (*serial_in)(struct uart_port *, int);
  34        void            (*serial_out)(struct uart_port *, int, int);
  35        void            (*set_termios)(struct uart_port *,
  36                                       struct ktermios *new,
  37                                       struct ktermios *old);
  38        int             (*handle_irq)(struct uart_port *);
  39        void            (*pm)(struct uart_port *, unsigned int state,
  40                              unsigned old);
  41        void            (*handle_break)(struct uart_port *);
  42};
  43
  44/*
  45 * Allocate 8250 platform device IDs.  Nothing is implied by
  46 * the numbering here, except for the legacy entry being -1.
  47 */
  48enum {
  49        PLAT8250_DEV_LEGACY = -1,
  50        PLAT8250_DEV_PLATFORM,
  51        PLAT8250_DEV_PLATFORM1,
  52        PLAT8250_DEV_PLATFORM2,
  53        PLAT8250_DEV_FOURPORT,
  54        PLAT8250_DEV_ACCENT,
  55        PLAT8250_DEV_BOCA,
  56        PLAT8250_DEV_EXAR_ST16C554,
  57        PLAT8250_DEV_HUB6,
  58        PLAT8250_DEV_AU1X00,
  59        PLAT8250_DEV_SM501,
  60};
  61
  62struct uart_8250_dma;
  63struct uart_8250_port;
  64
  65/**
  66 * 8250 core driver operations
  67 *
  68 * @setup_irq()         Setup irq handling. The universal 8250 driver links this
  69 *                      port to the irq chain. Other drivers may @request_irq().
  70 * @release_irq()       Undo irq handling. The universal 8250 driver unlinks
  71 *                      the port from the irq chain.
  72 */
  73struct uart_8250_ops {
  74        int             (*setup_irq)(struct uart_8250_port *);
  75        void            (*release_irq)(struct uart_8250_port *);
  76};
  77
  78/*
  79 * This should be used by drivers which want to register
  80 * their own 8250 ports without registering their own
  81 * platform device.  Using these will make your driver
  82 * dependent on the 8250 driver.
  83 */
  84
  85struct uart_8250_port {
  86        struct uart_port        port;
  87        struct timer_list       timer;          /* "no irq" timer */
  88        struct list_head        list;           /* ports on this IRQ */
  89        unsigned short          capabilities;   /* port capabilities */
  90        unsigned short          bugs;           /* port bugs */
  91        bool                    fifo_bug;       /* min RX trigger if enabled */
  92        unsigned int            tx_loadsz;      /* transmit fifo load size */
  93        unsigned char           acr;
  94        unsigned char           fcr;
  95        unsigned char           ier;
  96        unsigned char           lcr;
  97        unsigned char           mcr;
  98        unsigned char           mcr_mask;       /* mask of user bits */
  99        unsigned char           mcr_force;      /* mask of forced bits */
 100        unsigned char           cur_iotype;     /* Running I/O type */
 101        unsigned int            rpm_tx_active;
 102        unsigned char           canary;         /* non-zero during system sleep
 103                                                 *   if no_console_suspend
 104                                                 */
 105        unsigned char           probe;
 106#define UART_PROBE_RSA  (1 << 0)
 107
 108        /*
 109         * Some bits in registers are cleared on a read, so they must
 110         * be saved whenever the register is read but the bits will not
 111         * be immediately processed.
 112         */
 113#define LSR_SAVE_FLAGS UART_LSR_BRK_ERROR_BITS
 114        unsigned char           lsr_saved_flags;
 115#define MSR_SAVE_FLAGS UART_MSR_ANY_DELTA
 116        unsigned char           msr_saved_flags;
 117
 118        struct uart_8250_dma    *dma;
 119        const struct uart_8250_ops *ops;
 120
 121        /* 8250 specific callbacks */
 122        int                     (*dl_read)(struct uart_8250_port *);
 123        void                    (*dl_write)(struct uart_8250_port *, int);
 124};
 125
 126static inline struct uart_8250_port *up_to_u8250p(struct uart_port *up)
 127{
 128        return container_of(up, struct uart_8250_port, port);
 129}
 130
 131int serial8250_register_8250_port(struct uart_8250_port *);
 132void serial8250_unregister_port(int line);
 133void serial8250_suspend_port(int line);
 134void serial8250_resume_port(int line);
 135
 136extern int early_serial_setup(struct uart_port *port);
 137
 138extern unsigned int serial8250_early_in(struct uart_port *port, int offset);
 139extern void serial8250_early_out(struct uart_port *port, int offset, int value);
 140extern void serial8250_do_set_termios(struct uart_port *port,
 141                struct ktermios *termios, struct ktermios *old);
 142extern int serial8250_do_startup(struct uart_port *port);
 143extern void serial8250_do_shutdown(struct uart_port *port);
 144extern void serial8250_do_pm(struct uart_port *port, unsigned int state,
 145                             unsigned int oldstate);
 146extern void serial8250_do_set_mctrl(struct uart_port *port, unsigned int mctrl);
 147extern int fsl8250_handle_irq(struct uart_port *port);
 148int serial8250_handle_irq(struct uart_port *port, unsigned int iir);
 149unsigned char serial8250_rx_chars(struct uart_8250_port *up, unsigned char lsr);
 150void serial8250_tx_chars(struct uart_8250_port *up);
 151unsigned int serial8250_modem_status(struct uart_8250_port *up);
 152
 153extern void serial8250_set_isa_configurator(void (*v)
 154                                        (int port, struct uart_port *up,
 155                                                unsigned short *capabilities));
 156
 157#endif
 158