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

嵌入式Linux

开发平台:

C/C++

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