//
//    Copyright (C) 2007-2008 Sebastian Kuzminsky
//
//    This program is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    This program 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 General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with this program; if not, write to the Free Software
//    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
//


#include <rtapi_pci.h>

#define HM2_PCI_VERSION "0.7"

#define HM2_LLIO_NAME "hm2_pci"


#define HM2_PCI_MAX_BOARDS  8




// 
// PCI Device IDs and SubSystem Device IDs
//

#define HM2_PCI_VENDORID_PLX   (0x10B5)
#define HM2_PCI_VENDORID_MESA  (0x2718)
#define HM2_PCI_DEV_PLX9030    (0x9030)
#define HM2_PCI_DEV_PLX9054    (0x9054)
#define HM2_PCI_DEV_PLX9056    (0x9056)

#define HM2_PCI_DEV_MESA5I24   (0x5124)
#define HM2_PCI_DEV_MESA5I25   (0x5125)
#define HM2_PCI_DEV_MESA6I25   (0x6125)

#define HM2_PCI_SSDEV_5I20     (0x3131)

#define HM2_PCI_SSDEV_4I65     (0x3132)

#define HM2_PCI_SSDEV_5I21     (0x3312)

#define HM2_PCI_SSDEV_5I22_10  (0x3314)
#define HM2_PCI_SSDEV_5I22_15  (0x3313)

#define HM2_PCI_SSDEV_5I23     (0x3315)

#define HM2_PCI_SSDEV_5I24     (0x5124)
#define HM2_PCI_SSDEV_5I25     (0x5125)
#define HM2_PCI_SSDEV_6I25     (0x6125)

#define HM2_PCI_SSDEV_4I68     (0x3311)
#define HM2_PCI_SSDEV_4I68_OLD (0x3133)

#define HM2_PCI_SSDEV_4I69_16  (0x3472)
#define HM2_PCI_SSDEV_4I69_25  (0x3473)

#define HM2_PCI_SSDEV_3X20_10  (0x3427)
#define HM2_PCI_SSDEV_3X20_15  (0x3428)
#define HM2_PCI_SSDEV_3X20_20  (0x3429)




//
// the LAS?BRD registers are in the PLX 9030
//
// The HostMot2 firmware needs the #READY bit (0x2) set in order to work,
// but the EEPROMs on some older 5i20 cards dont set them right.
// The driver detects this problem and fixes it up.
//

#define LAS0BRD_OFFSET 0x28
#define LAS1BRD_OFFSET 0x2C
#define LAS2BRD_OFFSET 0x30
#define LAS3BRD_OFFSET 0x34

#define LASxBRD_READY 0x2




//
// PLX 9030 (5i20, 4i65)
//

/* I/O registers */
#define CTRL_STAT_OFFSET	0x0054	/* 9030 GPIO register (region 1) */

 /* bit number in 9030 GPIO register */
#define GPIO_3_MASK		(1<<11)	/* GPIO 3 */
#define DONE_MASK		(1<<11)	/* GPIO 3 */
#define _INIT_MASK		(1<<14)	/* GPIO 4 */
#define _LED_MASK		(1<<17)	/* GPIO 5 */
#define GPIO_6_MASK		(1<<20)	/* GPIO 6 */
#define _WRITE_MASK		(1<<23)	/* GPIO 7 */
#define _PROGRAM_MASK		(1<<26)	/* GPIO 8 */




//
// PLX 9054 (5i22, 5i23, 4i68, 4i69)
//
// Note: also used for the PLX 9056 (3x20)
//

/* I/O register indices.
*/
#define CTRL_STAT_OFFSET_5I22	0x006C /* 5I22 32-bit control/status register. */

/* bit number in 9054 GPIO register */
/* yes, the direction control bits are not in the same order as the I/O bits */
#define DONE_MASK_5I22			(1<<17)	/* GPI */
#define _PROGRAM_MASK_5I22		(1<<16)	/* GPO, active low */
#define DONE_ENABLE_5I22		(1<<18) /* GPI direction control, 1=input */
#define _PROG_ENABLE_5I22		(1<<19) /* GPO direction control, 1=output */

/* how long should we wait for DONE when programming 9054-based cards */
#define DONE_WAIT_5I22			20000




typedef struct {
    struct rtapi_pci_dev *dev;
    void rtapi__iomem *base;
    int len;
    unsigned long ctrl_base_addr;
    unsigned long data_base_addr;
    hm2_lowlevel_io_t llio;
} hm2_pci_t;