text: /* timskmod.h
   *
   * Copyright (C) 2010 - 2013 UNISYS CORPORATION
   * All rights reserved.
   *
   * 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, GOOD TITLE or
   * NON INFRINGEMENT.  See the GNU General Public License for more
   * details.
   */
  
  #ifndef __TIMSKMOD_H__
  #define __TIMSKMOD_H__
  
  #include <linux/version.h>
  #include <linux/init.h>
  #include <linux/kernel.h>
  #include <linux/device.h>
  #include <linux/kobject.h>
  #include <linux/sysfs.h>
  #include <linux/fs.h>
  #include <linux/string.h>
  #include <linux/sched.h>
  #include <linux/spinlock.h>
  #include <linux/slab.h>
  #include <linux/errno.h>
  #include <linux/interrupt.h>
  #include <linux/wait.h>
  #include <linux/vmalloc.h>
  #include <linux/proc_fs.h>
  #include <linux/cdev.h>
  #include <linux/types.h>
  #include <asm/irq.h>
  #include <linux/io.h>
  #include <asm/dma.h>
  #include <linux/uaccess.h>
  #include <linux/list.h>
  #include <linux/poll.h>
  /* #define EXPORT_SYMTAB */
  #include <linux/module.h>
  #include <linux/moduleparam.h>
  #include <linux/fcntl.h>
  #include <linux/workqueue.h>
  #include <linux/kthread.h>
  #include <linux/seq_file.h>
  #include <linux/mm.h>
  
  /* #define DEBUG */
  #ifndef BOOL
  #define BOOL    int
  #endif
  #define FALSE   0
  #define TRUE    1
  #if !defined SUCCESS
  #define SUCCESS 0
  #endif
  #define MIN(a, b)     (((a) < (b)) ? (a) : (b))
  #define MAX(a, b)     (((a) > (b)) ? (a) : (b))
  #define STRUCTSEQUAL(x, y) (memcmp(&x, &y, sizeof(x)) == 0)
  #ifndef HOSTADDRESS
  #define HOSTADDRESS unsigned long long
  #endif
  
  #define sizeofmember(TYPE, MEMBER) (sizeof(((TYPE *)0)->MEMBER))
  /** "Covered quotient" function */
  #define COVQ(v, d)  (((v) + (d) - 1) / (d))
  #define SWAPPOINTERS(p1, p2)				\
  	do {						\
  		void *SWAPPOINTERS_TEMP = (void *)p1;	\
  		(void *)(p1) = (void *)(p2);            \
  		(void *)(p2) = SWAPPOINTERS_TEMP;	\
  	} while (0)
  
  #define WARNDRV(fmt, args...)   LOGWRN(fmt, ## args)
  #define SECUREDRV(fmt, args...) LOGWRN(fmt, ## args)
  
  #define PRINTKDEV(devname, fmt, args...)  LOGINFDEV(devname, fmt, ## args)
  #define TBDDEV(devname, fmt, args...)     LOGERRDEV(devname, fmt, ## args)
  #define HUHDEV(devname, fmt, args...)     LOGERRDEV(devname, fmt, ## args)
  #define ERRDEV(devname, fmt, args...)     LOGERRDEV(devname, fmt, ## args)
  #define ERRDEVX(devno, fmt, args...)	  LOGERRDEVX(devno, fmt, ## args)
  #define WARNDEV(devname, fmt, args...)    LOGWRNDEV(devname, fmt, ## args)
  #define SECUREDEV(devname, fmt, args...)  LOGWRNDEV(devname, fmt, ## args)
  #define INFODEV(devname, fmt, args...)    LOGINFDEV(devname, fmt, ## args)
  #define INFODEVX(devno, fmt, args...)     LOGINFDEVX(devno, fmt, ## args)
  
  /** Verifies the consistency of your PRIVATEDEVICEDATA structure using
   *  conventional "signature" fields:
   *  <p>
   *  - sig1 should contain the size of the structure
   *  - sig2 should contain a pointer to the beginning of the structure
   */
  #define DDLOOKSVALID(dd)                                 \
  		((dd != NULL)                             &&	\
  		 ((dd)->sig1 == sizeof(PRIVATEDEVICEDATA)) &&	\
  		 ((dd)->sig2 == dd))
  
  /** Verifies the consistency of your PRIVATEFILEDATA structure using
   *  conventional "signature" fields:
   *  <p>
   *  - sig1 should contain the size of the structure
   *  - sig2 should contain a pointer to the beginning of the structure
   */
  #define FDLOOKSVALID(fd)                               \
  	((fd != NULL)                           &&     \
  	 ((fd)->sig1 == sizeof(PRIVATEFILEDATA)) &&    \
  	 ((fd)->sig2 == fd))
  
  /** Sleep for an indicated number of seconds (for use in kernel mode).
   *  x - the number of seconds to sleep.
   */
  #define SLEEP(x)					     \
  	do { __set_current_state(TASK_INTERRUPTIBLE);        \
  		schedule_timeout((x)*HZ);		     \
  	} while (0)
  
  /** Sleep for an indicated number of jiffies (for use in kernel mode).
   *  x - the number of jiffies to sleep.
   */
  #define SLEEPJIFFIES(x)						    \
  	do { __set_current_state(TASK_INTERRUPTIBLE);		    \
  		schedule_timeout(x);				    \
  	} while (0)
  
  static inline struct cdev *cdev_alloc_init(struct module *owner,
  					   const struct file_operations *fops)
  {
  	struct cdev *cdev = NULL;
  
  	cdev = cdev_alloc();
  	if (!cdev)
  		return NULL;
  	cdev->ops = fops;
  	cdev->owner = owner;
  
  	/* Note that the memory allocated for cdev will be deallocated
  	 * when the usage count drops to 0, because it is controlled
  	 * by a kobject of type ktype_cdev_dynamic.  (This
  	 * deallocation could very well happen outside of our kernel
  	 * module, like via the cdev_put in __fput() for example.)
  	 */
  	return cdev;
  }
  
  extern int unisys_spar_platform;
  
  #endif
  