Subversion Repositories zet86

/////////////////////////////////////////////////////////////////////////

// $Id: iodev.h,v 1.92 2008/04/17 14:39:32 sshwarts Exp $

/////////////////////////////////////////////////////////////////////////

//

//  Copyright (C) 2002  MandrakeSoft S.A.

//

//    MandrakeSoft S.A.

//    43, rue d'Aboukir

//    75002 Paris - France

//    http://www.linux-mandrake.com/

//    http://www.mandrakesoft.com/

//

//  I/O port handlers API Copyright (C) 2003 by Frank Cornelis

//

//  This library is free software; you can redistribute it and/or

//  modify it under the terms of the GNU Lesser General Public

//  License as published by the Free Software Foundation; either

//  version 2 of the License, or (at your option) any later version.

//

//  This library is distributed in the hope that it will be useful,

//  but WITHOUT ANY WARRANTY; without even the implied warranty of

//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

//  Lesser General Public License for more details.

//

//  You should have received a copy of the GNU Lesser General Public

//  License along with this library; if not, write to the Free Software

//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA

//

/////////////////////////////////////////////////////////////////////////

#ifndef IODEV_H

#define IODEV_H

#include "bochs.h"

/* maximum number of emulated devices allowed.  floppy, vga, etc...

   you can increase this to anything below 256 since an 8-bit handle

   is used for each device */

#define BX_MAX_IO_DEVICES 30

/* the last device in the array is the "default" I/O device */

#define BX_DEFAULT_IO_DEVICE   (BX_MAX_IO_DEVICES-1)

/* number of IRQ lines supported.  In an ISA PC there are two

   PIC chips cascaded together.  each has 8 IRQ lines, so there

   should be 16 IRQ's total */

#define BX_MAX_IRQS 16

#define BX_NO_IRQ  -1

class bx_pit_c;

#if BX_SUPPORT_APIC

class bx_ioapic_c;

#endif

#if BX_SUPPORT_IODEBUG

class bx_iodebug_c;

#endif

#if 0

class bx_g2h_c;

#endif

typedef Bit32u (*bx_read_handler_t)(void *, Bit32u, unsigned);

typedef void   (*bx_write_handler_t)(void *, Bit32u, Bit32u, unsigned);

#if BX_USE_DEV_SMF

#  define BX_DEV_SMF  static

#  define BX_DEV_THIS bx_devices.

#else

#  define BX_DEV_SMF

#  define BX_DEV_THIS this->

#endif

//////////////////////////////////////////////////////////////////////

// bx_devmodel_c declaration

//////////////////////////////////////////////////////////////////////

// This class defines virtual methods that are common to all devices.

// Child classes do not need to implement all of them, because in this

// definition they are defined as empty, as opposed to being pure

// virtual (= 0).

class BOCHSAPI bx_devmodel_c : public logfunctions {

  public:

  virtual ~bx_devmodel_c() {}

  virtual void init_mem(BX_MEM_C *) {}

  virtual void init(void) {}

  virtual void reset(unsigned type) {}

  virtual void register_state(void) {}

  virtual void after_restore_state(void) {}

};

//////////////////////////////////////////////////////////////////////

// declare stubs for PCI devices

//////////////////////////////////////////////////////////////////////

class bx_list_c;

// the best should be deriving of bx_pci_device_stub_c from bx_devmodel_c

// but it make serious problems for cirrus_svga device

class BOCHSAPI bx_pci_device_stub_c {

public:

  virtual ~bx_pci_device_stub_c() {}

  virtual Bit32u pci_read_handler(Bit8u address, unsigned io_len) {

    return 0;

  }

  virtual void pci_write_handler(Bit8u address, Bit32u value, unsigned io_len) {}

  void register_pci_state(bx_list_c *list, Bit8u *pci_conf);

};

//////////////////////////////////////////////////////////////////////

// declare stubs for devices

//////////////////////////////////////////////////////////////////////

//////////////////////////////////////////////////////////////////////

#define STUBFUNC(dev,method) \

   pluginlog->panic("%s called in %s stub. you must not have loaded the %s plugin", #dev, #method, #dev)

//////////////////////////////////////////////////////////////////////

class BOCHSAPI bx_keyb_stub_c : public bx_devmodel_c {

public:

  virtual ~bx_keyb_stub_c() {}

  // stubs for bx_keyb_c methods

  virtual void mouse_motion(int delta_x, int delta_y, int delta_z, unsigned button_state) {

    STUBFUNC(keyboard, mouse_motion);

  }

  virtual void gen_scancode(Bit32u key) {

    STUBFUNC(keyboard, gen_scancode);

  }

  virtual void paste_bytes(Bit8u *data, Bit32s length) {

    STUBFUNC(keyboard, paste_bytes);

  }

};

class BOCHSAPI bx_hard_drive_stub_c : public bx_devmodel_c {

public:

  virtual void   init() {

    STUBFUNC(HD, init);

  }

  virtual void   reset(unsigned type) {

    STUBFUNC(HD, reset);

  }

  virtual Bit32u   get_device_handle(Bit8u channel, Bit8u device) {

    STUBFUNC(HD, get_device_handle); return 0;

  }

  virtual Bit32u   get_first_cd_handle(void) {

    STUBFUNC(HD, get_first_cd_handle); return 0;

  }

  virtual unsigned get_cd_media_status(Bit32u handle) {

    STUBFUNC(HD, get_cd_media_status); return 0;

  }

  virtual unsigned set_cd_media_status(Bit32u handle, unsigned status) {

    STUBFUNC(HD, set_cd_media_status); return 0;

  }

  virtual Bit32u virt_read_handler(Bit32u address, unsigned io_len)

  {

    STUBFUNC(HD, virt_read_handler); return 0;

  }

  virtual void   virt_write_handler(Bit32u address,

      Bit32u value, unsigned io_len)

  {

    STUBFUNC(HD, virt_write_handler);

  }

  virtual bx_bool bmdma_read_sector(Bit8u channel, Bit8u *buffer, Bit32u *sector_size) {

    STUBFUNC(HD, bmdma_read_sector); return 0;

  }

  virtual bx_bool bmdma_write_sector(Bit8u channel, Bit8u *buffer) {

    STUBFUNC(HD, bmdma_write_sector); return 0;

  }

  virtual void bmdma_complete(Bit8u channel) {

    STUBFUNC(HD, bmdma_complete);

  }

};

class BOCHSAPI bx_floppy_stub_c : public bx_devmodel_c {

public:

  virtual unsigned get_media_status(unsigned drive) {

    STUBFUNC(floppy,  get_media_status); return 0;

  }

  virtual unsigned set_media_status(unsigned drive, unsigned status) {

    STUBFUNC(floppy, set_media_status); return 0;

  }

};

class BOCHSAPI bx_cmos_stub_c : public bx_devmodel_c {

public:

  virtual Bit32u get_reg(unsigned reg) {

    STUBFUNC(cmos, get_reg); return 0;

  }

  virtual void set_reg(unsigned reg, Bit32u val) {

    STUBFUNC(cmos, set_reg);

  }

  virtual time_t get_timeval() {

    return 0;

  }

  virtual void checksum_cmos(void) {

    STUBFUNC(cmos, checksum);

  }

};

class BOCHSAPI bx_dma_stub_c : public bx_devmodel_c {

public:

  virtual unsigned registerDMA8Channel(

    unsigned channel,

    void (* dmaRead)(Bit8u *data_byte),

    void (* dmaWrite)(Bit8u *data_byte),

    const char *name)

  {

    STUBFUNC(dma, registerDMA8Channel); return 0;

  }

  virtual unsigned registerDMA16Channel(

    unsigned channel,

    void (* dmaRead)(Bit16u *data_word),

    void (* dmaWrite)(Bit16u *data_word),

    const char *name)

  {

    STUBFUNC(dma, registerDMA16Channel); return 0;

  }

  virtual unsigned unregisterDMAChannel(unsigned channel) {

    STUBFUNC(dma, unregisterDMAChannel); return 0;

  }

  virtual unsigned get_TC(void) {

    STUBFUNC(dma, get_TC); return 0;

  }

  virtual void set_DRQ(unsigned channel, bx_bool val) {

    STUBFUNC(dma, set_DRQ);

  }

  virtual void raise_HLDA(void) {

    STUBFUNC(dma, raise_HLDA);

  }

};

class BOCHSAPI bx_pic_stub_c : public bx_devmodel_c {

public:

  virtual void raise_irq(unsigned irq_no) {

    STUBFUNC(pic, raise_irq);

  }

  virtual void lower_irq(unsigned irq_no) {

    STUBFUNC(pic, lower_irq);

  }

  virtual void set_mode(bx_bool ma_sl, Bit8u mode) {

    STUBFUNC(pic, set_mode);

  }

  virtual Bit8u IAC(void) {

    STUBFUNC(pic, IAC); return 0;

  }

  virtual void show_pic_state(void) {

    STUBFUNC(pic, show_pic_state);

  }

};

class BOCHSAPI bx_vga_stub_c : public bx_devmodel_c {

public:

  virtual void redraw_area(unsigned x0, unsigned y0,

                           unsigned width, unsigned height) {

    STUBFUNC(vga, redraw_area);

  }

  virtual Bit8u mem_read(Bit32u addr) {

    STUBFUNC(vga, mem_read);  return 0;

  }

  virtual void mem_write(Bit32u addr, Bit8u value) {

    STUBFUNC(vga, mem_write);

  }

  virtual void get_text_snapshot(Bit8u **text_snapshot,

                                 unsigned *txHeight, unsigned *txWidth) {

    STUBFUNC(vga, get_text_snapshot);

  }

  virtual void trigger_timer(void *this_ptr) {

    STUBFUNC(vga, trigger_timer);

  }

  virtual Bit8u get_actl_palette_idx(Bit8u index) {

    return 0;

  }

  virtual void dump_status(void) {}

};

class BOCHSAPI bx_pci_bridge_stub_c : public bx_devmodel_c, public bx_pci_device_stub_c {

public:

  virtual bx_bool register_pci_handlers(bx_pci_device_stub_c *device,

                                        Bit8u *devfunc, const char *name,

                                        const char *descr)

  {

    STUBFUNC(pci, register_pci_handlers); return 0;

  }

  virtual bx_bool is_pci_device(const char *name) {

    return 0;

  }

  virtual bx_bool pci_set_base_mem(void *this_ptr, memory_handler_t f1, memory_handler_t f2,

                                   Bit32u *addr, Bit8u *pci_conf, unsigned size) {

    STUBFUNC(pci, pci_set_base_mem);

    return 0;

  }

  virtual bx_bool pci_set_base_io(void *this_ptr, bx_read_handler_t f1, bx_write_handler_t f2,

                                  Bit32u *addr, Bit8u *pci_conf, unsigned size,

                                  const Bit8u *iomask, const char *name) {

    STUBFUNC(pci, pci_set_base_io);

    return 0;

  }

  virtual Bit8u rd_memType(Bit32u addr) { return 0; }

  virtual Bit8u wr_memType(Bit32u addr) { return 0; }

  virtual void print_i440fx_state(void) {}

};

class BOCHSAPI bx_pci2isa_stub_c : public bx_devmodel_c, public bx_pci_device_stub_c {

public:

  virtual void pci_set_irq (Bit8u devfunc, unsigned line, bx_bool level) {

    STUBFUNC(pci2isa, pci_set_irq);

  }

};

class BOCHSAPI bx_pci_ide_stub_c : public bx_devmodel_c, public bx_pci_device_stub_c {

public:

  virtual bx_bool bmdma_present(void) {

    return 0;

  }

  virtual void bmdma_set_irq(Bit8u channel) {}

};

class BOCHSAPI bx_ne2k_stub_c : public bx_devmodel_c {

public:

  virtual void print_info(FILE *file, int page, int reg, int nodups) {}

};

class BOCHSAPI bx_speaker_stub_c : public bx_devmodel_c {

public:

  virtual void beep_on(float frequency) {}

  virtual void beep_off() {}

};

class BOCHSAPI bx_serial_stub_c : public bx_devmodel_c {

public:

  virtual void serial_mouse_enq(int delta_x, int delta_y, int delta_z, unsigned button_state) {

    STUBFUNC(serial, serial_mouse_enq);

  }

};

#if BX_SUPPORT_PCIUSB

class BOCHSAPI bx_pci_usb_stub_c : public bx_devmodel_c, public bx_pci_device_stub_c {

public:

  virtual void usb_mouse_enq(int delta_x, int delta_y, int delta_z, unsigned button_state) {

    STUBFUNC(pciusb, usb_mouse_enq);

  }

  virtual void usb_mouse_enabled_changed(bx_bool enable) {

    STUBFUNC(pciusb, usb_mouse_enabled_changed);

  }

  virtual bx_bool usb_key_enq(Bit8u *scan_code) {

    STUBFUNC(pciusb, usb_key_enq);

    return 0;

  }

  virtual bx_bool usb_keyboard_connected() { return 0; }

  virtual bx_bool usb_mouse_connected() { return 0; }

};

#endif

#if BX_SUPPORT_ACPI

class BOCHSAPI bx_acpi_ctrl_stub_c : public bx_devmodel_c, public bx_pci_device_stub_c {

public:

  virtual void generate_smi(Bit8u value) {}

};

#endif

#if BX_SUPPORT_BUSMOUSE

class BOCHSAPI bx_busm_stub_c : public bx_devmodel_c {

public:

  virtual void bus_mouse_enq(int delta_x, int delta_y, int delta_z, unsigned button_state) {

    STUBFUNC(busmouse, bus_mouse_enq);

  }

};

#endif

class BOCHSAPI bx_devices_c : public logfunctions {

public:

  bx_devices_c(void);

 ~bx_devices_c(void);

  // Initialize the device stubs (in constructur and exit())

  void init_stubs(void);

  // Register I/O addresses and IRQ lines. Initialize any internal

  // structures.  init() is called only once, even if the simulator

  // reboots or is restarted.

  void init(BX_MEM_C *);

  // Enter reset state in response to a reset condition.

  // The types of reset conditions are defined in bochs.h:

  // power-on, hardware, or software.

  void reset(unsigned type);

  // Cleanup the devices when the simulation quits.

  void exit(void);

  void register_state(void);

  void after_restore_state(void);

  BX_MEM_C *mem;  // address space associated with these devices

  bx_bool register_io_read_handler(void *this_ptr, bx_read_handler_t f,

                                   Bit32u addr, const char *name, Bit8u mask);

  bx_bool unregister_io_read_handler(void *this_ptr, bx_read_handler_t f,

                                     Bit32u addr, Bit8u mask);

  bx_bool register_io_write_handler(void *this_ptr, bx_write_handler_t f,

                                    Bit32u addr, const char *name, Bit8u mask);

  bx_bool unregister_io_write_handler(void *this_ptr, bx_write_handler_t f,

                                      Bit32u addr, Bit8u mask);

  bx_bool register_io_read_handler_range(void *this_ptr, bx_read_handler_t f,

                                         Bit32u begin_addr, Bit32u end_addr,

                                         const char *name, Bit8u mask);

  bx_bool register_io_write_handler_range(void *this_ptr, bx_write_handler_t f,

                                          Bit32u begin_addr, Bit32u end_addr,

                                          const char *name, Bit8u mask);

  bx_bool unregister_io_read_handler_range(void *this_ptr, bx_read_handler_t f,

                                           Bit32u begin, Bit32u end, Bit8u mask);

  bx_bool unregister_io_write_handler_range(void *this_ptr, bx_write_handler_t f,

                                            Bit32u begin, Bit32u end, Bit8u mask);

  bx_bool register_default_io_read_handler(void *this_ptr, bx_read_handler_t f, const char *name, Bit8u mask);

  bx_bool register_default_io_write_handler(void *this_ptr, bx_write_handler_t f, const char *name, Bit8u mask);

  bx_bool register_irq(unsigned irq, const char *name);

  bx_bool unregister_irq(unsigned irq, const char *name);

  Bit32u inp(Bit16u addr, unsigned io_len) BX_CPP_AttrRegparmN(2);

  void   outp(Bit16u addr, Bit32u value, unsigned io_len) BX_CPP_AttrRegparmN(3);

  static void timer_handler(void *);

  void timer(void);

  bx_devmodel_c     *pluginBiosDevice;

#if BX_SUPPORT_APIC

  bx_ioapic_c       *ioapic;

#endif

  bx_pci_bridge_stub_c *pluginPciBridge;

  bx_pci2isa_stub_c *pluginPci2IsaBridge;

  bx_pci_ide_stub_c *pluginPciIdeController;

#if BX_SUPPORT_ACPI

  bx_acpi_ctrl_stub_c *pluginACPIController;

#endif

  bx_devmodel_c     *pluginPciVgaAdapter;

  bx_devmodel_c     *pluginPciDevAdapter;

  bx_devmodel_c     *pluginPciPNicAdapter;

  bx_pit_c          *pit;

  bx_keyb_stub_c    *pluginKeyboard;

  bx_dma_stub_c     *pluginDmaDevice;

  bx_floppy_stub_c  *pluginFloppyDevice;

  bx_cmos_stub_c    *pluginCmosDevice;

  bx_serial_stub_c  *pluginSerialDevice;

#if BX_SUPPORT_PCIUSB

  bx_pci_usb_stub_c *pluginPciUSBAdapter;

#endif

  bx_devmodel_c     *pluginParallelDevice;

  bx_devmodel_c     *pluginHdemuDevice;

  bx_devmodel_c     *pluginUnmapped;

  bx_vga_stub_c     *pluginVgaDevice;

  bx_pic_stub_c     *pluginPicDevice;

  bx_hard_drive_stub_c *pluginHardDrive;

  bx_devmodel_c     *pluginSB16Device;

  bx_ne2k_stub_c    *pluginNE2kDevice;

  bx_devmodel_c     *pluginExtFpuIrq;

  bx_devmodel_c     *pluginGameport;

  bx_speaker_stub_c *pluginSpeaker;

#if BX_SUPPORT_BUSMOUSE

  bx_busm_stub_c    *pluginBusMouse;

#endif

#if BX_SUPPORT_IODEBUG

  bx_iodebug_c      *iodebug;

#endif

#if 0

  bx_g2h_c          *g2h;

#endif

  // stub classes that the pointers (above) can point to until a plugin is

  // loaded

  bx_cmos_stub_c stubCmos;

  bx_keyb_stub_c stubKeyboard;

#if BX_SUPPORT_BUSMOUSE

  bx_busm_stub_c stubBusMouse;

#endif

  bx_hard_drive_stub_c stubHardDrive;

  bx_dma_stub_c  stubDma;

  bx_pic_stub_c  stubPic;

  bx_floppy_stub_c  stubFloppy;

  bx_vga_stub_c  stubVga;

  bx_pci_bridge_stub_c  stubPci;

  bx_pci2isa_stub_c stubPci2Isa;

  bx_pci_ide_stub_c stubPciIde;

  bx_ne2k_stub_c    stubNE2k;

  bx_speaker_stub_c stubSpeaker;

  bx_serial_stub_c  stubSerial;

#if BX_SUPPORT_PCIUSB

  bx_pci_usb_stub_c stubUsbAdapter;

#endif

#if BX_SUPPORT_ACPI

  bx_acpi_ctrl_stub_c stubACPIController;

#endif

  // Some info to pass to devices which can handled bulk IO.  This allows

  // the interface to remain the same for IO devices which can't handle

  // bulk IO.  We should probably implement special INPBulk() and OUTBulk()

  // functions which stick these values in the bx_devices_c class, and

  // then call the normal functions rather than having gross globals

  // variables.

  Bit8u*   bulkIOHostAddr;

  unsigned bulkIOQuantumsRequested;

  unsigned bulkIOQuantumsTransferred;

private:

  struct io_handler_struct {

        struct io_handler_struct *next;

        struct io_handler_struct *prev;

        void *funct; // C++ type checking is great, but annoying

        void *this_ptr;

        char *handler_name;  // name of device

        int usage_count;

        Bit8u mask;          // io_len mask

  };

  struct io_handler_struct io_read_handlers;

  struct io_handler_struct io_write_handlers;

#define PORTS 0x10000

  struct io_handler_struct **read_port_to_handler;

  struct io_handler_struct **write_port_to_handler;

  // more for informative purposes, the names of the devices which

  // are use each of the IRQ 0..15 lines are stored here

  char *irq_handler_name[BX_MAX_IRQS];

  static Bit32u read_handler(void *this_ptr, Bit32u address, unsigned io_len);

  static void   write_handler(void *this_ptr, Bit32u address, Bit32u value, unsigned io_len);

  BX_DEV_SMF Bit32u port92_read(Bit32u address, unsigned io_len);

  BX_DEV_SMF void   port92_write(Bit32u address, Bit32u value, unsigned io_len);

  static Bit32u default_read_handler(void *this_ptr, Bit32u address, unsigned io_len);

  static void   default_write_handler(void *this_ptr, Bit32u address, Bit32u value, unsigned io_len);

  int timer_handle;

  bx_bool is_serial_enabled();

  bx_bool is_usb_enabled();

  bx_bool is_parallel_enabled();

};

// memory stub has an assumption that there are no memory accesses splitting 4K page

BX_CPP_INLINE void DEV_MEM_READ_PHYSICAL(bx_phy_address phy_addr, unsigned len, Bit8u *ptr)

{

  while(len > 0) {

    unsigned remainingInPage = 0x1000 - (phy_addr & 0xfff);

    if (len < remainingInPage) remainingInPage = len;

    BX_MEM(0)->readPhysicalPage(NULL, phy_addr, remainingInPage, ptr);

    ptr += remainingInPage;

    phy_addr += remainingInPage;

    len -= remainingInPage;

  }

}

// memory stub has an assumption that there are no memory accesses splitting 4K page

BX_CPP_INLINE void DEV_MEM_WRITE_PHYSICAL(bx_phy_address phy_addr, unsigned len, Bit8u *ptr)

{

  while(len > 0) {

    unsigned remainingInPage = 0x1000 - (phy_addr & 0xfff);

    if (len < remainingInPage) remainingInPage = len;

    BX_MEM(0)->writePhysicalPage(NULL, phy_addr, remainingInPage, ptr);

    ptr += remainingInPage;

    phy_addr += remainingInPage;

    len -= remainingInPage;

  }

}

#ifndef NO_DEVICE_INCLUDES

#if BX_SUPPORT_PCI

#include "iodev/pci.h"

#include "iodev/pci2isa.h"

#include "iodev/pci_ide.h"

#if BX_SUPPORT_ACPI

#include "iodev/acpi.h"

#endif

#if BX_SUPPORT_PCIVGA

#include "iodev/pcivga.h"

#endif

#if BX_SUPPORT_PCIDEV

#include "iodev/pcidev.h"

#endif

#if BX_SUPPORT_PCIUSB

#include "iodev/pciusb.h"

#endif

#endif

#include "iodev/vga.h"

#if BX_SUPPORT_APIC

#  include "iodev/ioapic.h"

#endif

#include "iodev/biosdev.h"

#include "iodev/cmos.h"

#include "iodev/dma.h"

#include "iodev/floppy.h"

#include "iodev/harddrv.h"

#if BX_SUPPORT_IODEBUG

#   include "iodev/iodebug.h"

#endif

#include "iodev/keyboard.h"

#if BX_SUPPORT_BUSMOUSE

#   include "iodev/busmouse.h"

#endif

#include "iodev/parallel.h"

#include "iodev/hdemu.h"

#include "iodev/pic.h"

#include "iodev/pit_wrap.h"

#include "iodev/virt_timer.h"

#include "iodev/serial.h"

#if BX_SUPPORT_SB16

#  include "iodev/sb16.h"

#endif

#include "iodev/unmapped.h"

#include "iodev/ne2k.h"

#if BX_SUPPORT_PCIPNIC

#include "iodev/pcipnic.h"

#endif

#include "iodev/guest2host.h"

#include "iodev/slowdown_timer.h"

#include "iodev/extfpuirq.h"

#include "iodev/gameport.h"

#endif /* NO_DEVICE_INCLUDES */

#if BX_PROVIDE_DEVICE_MODELS

BOCHSAPI extern bx_devices_c bx_devices;

#endif

#endif /* IODEV_H */