/***
 * pexor_common.h
 *
 *  Created on: 08.04.2014 - 06.2024
 *      Author: J. Adamczewski-Musch, GSI
 *
 *      PEXOR/KINPEX driver common includes for all modules
 */

#ifndef _PCI_PEX_COMMON_H_
#define _PCI_PEX_COMMON_H_

#include <linux/kernel.h>
#include <linux/version.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/init.h>
#include <linux/cdev.h>
#include <linux/sysfs.h>
#include <linux/fs.h>
#include <linux/interrupt.h>
#include <linux/delay.h>
#include <linux/mm.h>
#include <linux/pagemap.h>
#include <linux/scatterlist.h>
#include <linux/page-flags.h>
#include <linux/sched.h>
#include <linux/vmalloc.h>

#include <linux/wait.h>

/**
#include <asm/uaccess.h>
#include <asm/atomic.h>
#include <asm/io.h>

*/

/*
#include <asm/system.h>
*/

#include "pex_user.h"

/** ids for pexor card:*/
#define PEXOR_VENDOR_ID 0x1204
#define PEXOR_DEVICE_ID 0x5303

#define PEXARIA_VENDOR_ID     0x1172
#define PEXARIA_DEVICE_ID     0x1111

#define KINPEX_VENDOR_ID     0x10EE
#define KINPEX_DEVICE_ID     0x1111


#define BOARDTYPE_PEXOR 0
#define BOARDTYPE_PEXARIA 1
#define BOARDTYPE_KINPEX 2

#define PEXAUTHORS     "Nikolaus Kurz, Joern Adamczewski-Musch, EEL, GSI, 2015-2024"
#define PEXDESC        "MBSPEX driver for PCIe DAQ with Multi Branch System"
#define PEXVERSION     "3.03"


//#define PEX_DEBUGPRINT 1


/* debug latencies of trigger/token request*/
//#define PEX_TRIGGERDEBUG 1

/* enable this to get printouts of GTX/MCMCM setups  */
//#define PEX_GTXDEBUG 1


/** this will enable a faster parameter copy between kernel and user space at ioctls
 * but system most likely will crash when daq is interrupted with resl*/
//#define PEX_COPY_USER_NOCHECK 1


/** this disables that pages of pipe will locked to memory
 * when creating scatter-gather list for virtual pipes, avoiding
 * a deadlock with readout or collector process.
 * The idea is that shared memory pipe will do a memory lock anyway.
 *  */
#define PEX_SG_NO_MEMLOCK 1


/* if defined we merge together physically adjacent pages in sg list as delivered from system
 * Note that this is _not_ done by pci_map_sg by default.
 * May disable merging for testing purposes*/
#define PEX_SG_REDUCE_SGLIST 1


/* if set, complete mbs pipe is synced for device/cpu at each ioctl readdmapipe.
 * if undefined, we will sync only parts of sglist that have been touched*/
#define PEX_SG_SYNCFULLPIPE 1

/* if this is set, first mmap of mbs pipe will also do mapping of complete pipe
 * to kernel space, for later use in token parallel ioctl (write padding words)*/
#define PEX_PREMAP_PIPE_TO_KERNELSPACE 1

/**JAM 27-06-24: mremap instead of ioremap_cache when mapping pipe to write the padding words (parallel token request ioctl)*/
#define PEX_USE_MREMAP 1




/** maximum number of devices controlled by this driver*/
#define PEX_MAXDEVS 4

///////////////////////////////////77

/** enable usage of TRIXOR */
#define PEX_WITH_TRIXOR 1


//#define INTERNAL_TRIG_TEST 1





/** timeout for ir wait queue, set to 5 s for slow poland tests */
#define PEX_WAIT_TIMEOUT (5*HZ)
/** maximum number of timeouts before wait loop terminates*/
#define PEX_WAIT_MAXTIMEOUTS 20


/** JAM23: enable this for 64 bit DMA (new kinpex code)*/
#define PEX_DMA_64BIT 1


/** maximum number of polling cycles for dma complete bit*/
#define PEX_DMA_MAXPOLLS 10000

/** polling delay for each cycle in ns for dma complete bit*/
#define PEX_DMA_POLLDELAY 0
// 0
//20

/** if set, we use a schedule() in the dma complete polling.
 * Note: according to linux kernel book, yield() will just prepare this
 * task to be scheduled in near future, but schedule() will initiate the
 * schedule directly*/
#define PEX_DMA_POLL_SCHEDULE 1
//1

/* with this define we can disable the ioctl semaphore
 * for performance reason?*/
//#define PEX_NO_IOCTL_SEM 1


#define PEX_ENABLE_IRQ 1

/** use waitqueue after isr instead of semaphore
 * NOTE: this does not make sense with mbs/pipe, because we do
 * not have automatic dma readout to kernel buffer queue as in dabc driver here!*/
/**#define PEX_IRQ_WAITQUEUE 1*/

#define PEX_SYSFS_ENABLE 1


#ifdef PEX_DEBUGPRINT
#define pex_dbg( args... )                    \
  printk( args );
#else
#define pex_dbg( args... ) ;
#endif

#ifdef PEX_TRIGGERDEBUG
#define pex_tdbg( args... )                    \
  printk( args );
#else
#define pex_tdbg( args... ) ;
#endif




#define pex_msg( args... )                    \
  printk( args );


struct pex_privdata;


// here switch different copy to/from user functions
// the regular copy may sleep, the "__" one not but may crash
// in case of page fault! better do not use this

#ifdef PEX_COPY_USER_NOCHECK

#if LINUX_VERSION_CODE >= KERNEL_VERSION(3,2,0)
#define pex_copy_to_user __copy_to_user_inatomic
#define pex_copy_from_user __copy_from_user_inatomic
#else
#define pex_copy_to_user copy_to_user
#define pex_copy_from_user copy_from_user
#endif

#else

#define pex_copy_to_user copy_to_user
#define pex_copy_from_user copy_from_user

#endif


#endif