/*
 * 86Box    A hypervisor and IBM PC system emulator that specializes in
 *          running old operating systems and software designed for IBM
 *          PC systems and compatibles from 1981 through fairly recent
 *          system designs based on the PCI bus.
 *
 *          This file is part of the 86Box distribution.
 *
 *          Definitions for the NS8250/16450/16550/16650/16750/16850/16950
 *          UART emulation.
 *
 *
 *
 * Authors: Sarah Walker, <https://pcem-emulator.co.uk/>
 *          Miran Grca, <mgrca8@gmail.com>
 *          Fred N. van Kempen, <decwiz@yahoo.com>
 *
 *          Copyright 2008-2020 Sarah Walker.
 *          Copyright 2016-2020 Miran Grca.
 *          Copyright 2017-2020 Fred N. van Kempen.
 */

#ifndef EMU_SERIAL_H
#define EMU_SERIAL_H

#define SERIAL_8250      0
#define SERIAL_8250_PCJR 1
#define SERIAL_16450     2
#define SERIAL_16550     3
#define SERIAL_16650     4
#define SERIAL_16750     5
#define SERIAL_16850     6
#define SERIAL_16950     7

#define SERIAL_FIFO_SIZE 16

/* Default settings for the standard ports. */
#define COM1_ADDR 0x03f8
#define COM1_IRQ  4
#define COM2_ADDR 0x02f8
#define COM2_IRQ  3
#define COM3_ADDR 0x03e8
#define COM3_IRQ  4
#define COM4_ADDR 0x02e8
#define COM4_IRQ  3

struct serial_device_s;
struct serial_s;

typedef struct serial_s {
    uint8_t lsr, thr, mctrl, rcr,
        iir, ier, lcr, msr,
        dat, int_status, scratch, fcr,
        irq, type, inst, transmit_enabled,
        fifo_enabled, rcvr_fifo_len, bits, data_bits,
        baud_cycles, rcvr_fifo_full, txsr, out,
        msr_set, pad, pad0, pad1;

    uint16_t dlab, base_address, out_new, pad2;

    uint8_t rcvr_fifo_pos, xmit_fifo_pos,
        rcvr_fifo_end, xmit_fifo_end,
        rcvr_fifo[SERIAL_FIFO_SIZE], xmit_fifo[SERIAL_FIFO_SIZE];

    pc_timer_t transmit_timer, timeout_timer,
               receive_timer;
    double     clock_src, transmit_period;

    struct serial_device_s *sd;
} serial_t;

typedef struct serial_device_s {
    void (*rcr_callback)(struct serial_s *serial, void *p);
    void (*dev_write)(struct serial_s *serial, void *p, uint8_t data);
    void (*lcr_callback)(struct serial_s *serial, void *p, uint8_t lcr);
    void (*transmit_period_callback)(struct serial_s *serial, void *p, double transmit_period);
    void     *priv;
    serial_t *serial;
} serial_device_t;

typedef struct {
    uint8_t enabled;
} serial_port_t;

extern serial_port_t com_ports[SERIAL_MAX];

extern serial_t *serial_attach(int port,
                               void (*rcr_callback)(struct serial_s *serial, void *p),
                               void (*dev_write)(struct serial_s *serial, void *p, uint8_t data),
                               void *priv);
extern serial_t *serial_attach_ex(int port,
                                  void (*rcr_callback)(struct serial_s *serial, void *p),
                                  void (*dev_write)(struct serial_s *serial, void *p, uint8_t data),
                                  void (*transmit_period_callback)(struct serial_s *serial, void *p, double transmit_period),
                                  void (*lcr_callback)(struct serial_s *serial, void *p, uint8_t data_bits),
                                  void *priv);
extern void      serial_remove(serial_t *dev);
extern void      serial_set_type(serial_t *dev, int type);
extern void      serial_setup(serial_t *dev, uint16_t addr, uint8_t irq);
extern void      serial_clear_fifo(serial_t *dev);
extern void      serial_write_fifo(serial_t *dev, uint8_t dat);
extern void      serial_set_next_inst(int ni);
extern void      serial_standalone_init(void);
extern void      serial_set_clock_src(serial_t *dev, double clock_src);
extern void      serial_reset_port(serial_t *dev);
extern void      serial_device_timeout(void *priv);

extern void serial_set_cts(serial_t *dev, uint8_t enabled);
extern void serial_set_dsr(serial_t *dev, uint8_t enabled);
extern void serial_set_dcd(serial_t *dev, uint8_t enabled);

extern const device_t ns8250_device;
extern const device_t ns8250_pcjr_device;
extern const device_t ns16450_device;
extern const device_t ns16550_device;
extern const device_t ns16650_device;
extern const device_t ns16750_device;
extern const device_t ns16850_device;
extern const device_t ns16950_device;

#endif /*EMU_SERIAL_H*/