scull.h
上传用户:wudi5211
上传日期:2010-01-21
资源大小:607k
文件大小:6k
源码类别:

嵌入式Linux

开发平台:

C/C++

  1. /*
  2.  * scull.h -- definitions for the char module
  3.  *
  4.  * $Id: scull.h,v 1.9 2000/11/30 18:34:25 rubini Exp $
  5.  */
  6. #ifndef _SCULL_H_
  7. #define _SCULL_H_
  8. #include <linux/ioctl.h> /* needed for the _IOW etc stuff used later */
  9. /* version dependencies have been confined to a separate file */
  10. #include "sysdep.h"
  11. /*
  12.  * Macros to help debugging
  13.  */
  14. #undef PDEBUG             /* undef it, just in case */
  15. #ifdef SCULL_DEBUG
  16. #  ifdef __KERNEL__
  17.      /* This one if debugging is on, and kernel space */
  18. #    define PDEBUG(fmt, args...) printk( KERN_DEBUG "scull: " fmt, ## args)
  19. #  else
  20.      /* This one for user space */
  21. #    define PDEBUG(fmt, args...) fprintf(stderr, fmt, ## args)
  22. #  endif
  23. #else
  24. #  define PDEBUG(fmt, args...) /* not debugging: nothing */
  25. #endif
  26. #undef PDEBUGG
  27. #define PDEBUGG(fmt, args...) /* nothing: it's a placeholder */
  28. #ifndef SCULL_MAJOR
  29. #define SCULL_MAJOR 0   /* dynamic major by default */
  30. #endif
  31. #ifndef SCULL_NR_DEVS
  32. #define SCULL_NR_DEVS 4    /* scull0 through scull3 */
  33. #endif
  34. #ifndef SCULL_P_NR_DEVS
  35. #define SCULL_P_NR_DEVS 4  /* scullpipe0 through scullpipe3 */
  36. #endif
  37. /*
  38.  * The bare device is a variable-length region of memory.
  39.  * Use a linked list of indirect blocks.
  40.  *
  41.  * "Scull_Dev->data" points to an array of pointers, each
  42.  * pointer refers to a memory area of SCULL_QUANTUM bytes.
  43.  *
  44.  * The array (quantum-set) is SCULL_QSET long.
  45.  */
  46. #ifndef SCULL_QUANTUM
  47. #define SCULL_QUANTUM 4000
  48. #endif
  49. #ifndef SCULL_QSET
  50. #define SCULL_QSET    1000
  51. #endif
  52. /*
  53.  * The pipe device is a simple circular buffer. Here its default size
  54.  */
  55. #ifndef SCULL_P_BUFFER
  56. #define SCULL_P_BUFFER 4000
  57. #endif
  58. #ifdef CONFIG_DEVFS_FS /* only if enabled, to avoid errors in 2.0 */
  59. #include <linux/devfs_fs_kernel.h>
  60. #else
  61.   typedef void * devfs_handle_t;  /* avoid #ifdef inside the structure */
  62. #endif
  63. /*
  64.  * This is somehow a hack: avoid ifdefs in the cleanup code by declaring
  65.  * an empty procedure as a placeholder for devfs_unregister. This is
  66.  * only done *unless* <linux/devfs_fs_kernel.h> was included, as that
  67.  * header already implements placeholder for all the devfs functions
  68.  */
  69. /*............................................... degin-tag devfs-ifdef */
  70. #ifndef DEVFS_FL_DEFAULT
  71. extern inline void devfs_unregister(devfs_handle_t de) {}
  72. #endif
  73. extern devfs_handle_t scull_devfs_dir;
  74. typedef struct Scull_Dev {
  75.    void **data;
  76.    struct Scull_Dev *next;   /* next listitem */
  77.    int quantum;              /* the current quantum size */
  78.    int qset;                 /* the current array size */
  79.    unsigned long size;
  80.    devfs_handle_t handle;    /* only used if devfs is there */
  81.    unsigned int access_key;  /* used by sculluid and scullpriv */
  82.    struct semaphore sem;     /* mutual exclusion semaphore     */
  83. } Scull_Dev;
  84. /*
  85.  * Split minors in two parts
  86.  */
  87. #define TYPE(dev)   (MINOR(dev) >> 4)  /* high nibble */
  88. #define NUM(dev)    (MINOR(dev) & 0xf) /* low  nibble */
  89. /*
  90.  * Different minors behave differently, so let's use multiple fops
  91.  */
  92. extern struct file_operations scull_fops;        /* simplest: global */
  93. extern struct file_operations scull_priv_fops;   /* private region   */
  94. extern struct file_operations scull_pipe_fops;   /* circular buffer  */
  95. extern struct file_operations scull_sngl_fops;   /* single open      */
  96. extern struct file_operations scull_user_fops;   /* single process   */
  97. extern struct file_operations scull_wusr_fops;   /* single user      */
  98. /*
  99.  * The different configurable parameters
  100.  */
  101. extern int scull_major;     /* main.c */
  102. extern int scull_nr_devs;
  103. extern int scull_quantum;
  104. extern int scull_qset;
  105. extern int scull_p_nr_devs;    /* pipe.c */
  106. extern int scull_p_buffer;
  107. /*
  108.  * Prototypes for shared functions
  109.  */
  110. int     scull_p_init(void);
  111. void    scull_p_cleanup(void);
  112. int     scull_access_init(void);
  113. void    scull_access_cleanup(void);
  114. int     scull_trim(Scull_Dev *dev);
  115. ssize_t scull_read (struct file *filp, char *buf, size_t count,
  116.                     loff_t *f_pos);
  117. ssize_t scull_write (struct file *filp, const char *buf, size_t count,
  118.                      loff_t *f_pos);
  119. loff_t  scull_llseek (struct file *filp, loff_t off, int whence);
  120. int     scull_ioctl (struct inode *inode, struct file *filp,
  121.                      unsigned int cmd, unsigned long arg);
  122. /*
  123.  * Ioctl definitions
  124.  */
  125. /* Use 'k' as magic number */
  126. #define SCULL_IOC_MAGIC  'k'
  127. #define SCULL_IOCRESET    _IO(SCULL_IOC_MAGIC, 0)
  128. /*
  129.  * S means "Set" through a ptr,
  130.  * T means "Tell" directly with the argument value
  131.  * G means "Get": reply by setting through a pointer
  132.  * Q means "Query": response is on the return value
  133.  * X means "eXchange": G and S atomically
  134.  * H means "sHift": T and Q atomically
  135.  */
  136. #define SCULL_IOCSQUANTUM _IOW(SCULL_IOC_MAGIC,  1, scull_quantum)
  137. #define SCULL_IOCSQSET    _IOW(SCULL_IOC_MAGIC,  2, scull_qset)
  138. #define SCULL_IOCTQUANTUM _IO(SCULL_IOC_MAGIC,   3)
  139. #define SCULL_IOCTQSET    _IO(SCULL_IOC_MAGIC,   4)
  140. #define SCULL_IOCGQUANTUM _IOR(SCULL_IOC_MAGIC,  5, scull_quantum)
  141. #define SCULL_IOCGQSET    _IOR(SCULL_IOC_MAGIC,  6, scull_qset)
  142. #define SCULL_IOCQQUANTUM _IO(SCULL_IOC_MAGIC,   7)
  143. #define SCULL_IOCQQSET    _IO(SCULL_IOC_MAGIC,   8)
  144. #define SCULL_IOCXQUANTUM _IOWR(SCULL_IOC_MAGIC, 9, scull_quantum)
  145. #define SCULL_IOCXQSET    _IOWR(SCULL_IOC_MAGIC,10, scull_qset)
  146. #define SCULL_IOCHQUANTUM _IO(SCULL_IOC_MAGIC,  11)
  147. #define SCULL_IOCHQSET    _IO(SCULL_IOC_MAGIC,  12)
  148. /*
  149.  * The other entities only have "Tell" and "Query", because they're
  150.  * not printed in the book, and there's no need to have all six.
  151.  * (The previous stuff was only there to show different ways to do it.
  152.  */
  153. #define SCULL_P_IOCTSIZE _IO(SCULL_IOC_MAGIC,   13)
  154. #define SCULL_P_IOCQSIZE _IO(SCULL_IOC_MAGIC,   14)
  155. /* ... more to come */
  156. #define SCULL_IOCHARDRESET _IO(SCULL_IOC_MAGIC, 15) /* debugging tool */
  157. #define SCULL_IOC_MAXNR 15
  158. #endif /* _SCULL_H_ */