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

嵌入式Linux

开发平台:

C/C++

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