Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ]
Version: [ 2.6.11.8 ] [ 2.6.25 ] [ 2.6.25.8 ] [ 2.6.31.13 ] Architecture: [ i386 ]
  1 #ifndef _LINUX_GENHD_H
  2 #define _LINUX_GENHD_H
  3 
  4 /*
  5  *      genhd.h Copyright (C) 1992 Drew Eckhardt
  6  *      Generic hard disk header file by  
  7  *              Drew Eckhardt
  8  *
  9  *              <drew@colorado.edu>
 10  */
 11 
 12 #include <linux/types.h>
 13 #include <linux/kdev_t.h>
 14 
 15 #ifdef CONFIG_BLOCK
 16 
 17 #define kobj_to_dev(k) container_of(k, struct device, kobj)
 18 #define dev_to_disk(device) container_of(device, struct gendisk, dev)
 19 #define dev_to_part(device) container_of(device, struct hd_struct, dev)
 20 
 21 extern struct device_type part_type;
 22 extern struct kobject *block_depr;
 23 extern struct class block_class;
 24 
 25 extern const struct seq_operations partitions_op;
 26 extern const struct seq_operations diskstats_op;
 27 
 28 enum {
 29 /* These three have identical behaviour; use the second one if DOS FDISK gets
 30    confused about extended/logical partitions starting past cylinder 1023. */
 31         DOS_EXTENDED_PARTITION = 5,
 32         LINUX_EXTENDED_PARTITION = 0x85,
 33         WIN98_EXTENDED_PARTITION = 0x0f,
 34 
 35         SUN_WHOLE_DISK = DOS_EXTENDED_PARTITION,
 36 
 37         LINUX_SWAP_PARTITION = 0x82,
 38         LINUX_DATA_PARTITION = 0x83,
 39         LINUX_LVM_PARTITION = 0x8e,
 40         LINUX_RAID_PARTITION = 0xfd,    /* autodetect RAID partition */
 41 
 42         SOLARIS_X86_PARTITION = LINUX_SWAP_PARTITION,
 43         NEW_SOLARIS_X86_PARTITION = 0xbf,
 44 
 45         DM6_AUX1PARTITION = 0x51,       /* no DDO:  use xlated geom */
 46         DM6_AUX3PARTITION = 0x53,       /* no DDO:  use xlated geom */
 47         DM6_PARTITION = 0x54,           /* has DDO: use xlated geom & offset */
 48         EZD_PARTITION = 0x55,           /* EZ-DRIVE */
 49 
 50         FREEBSD_PARTITION = 0xa5,       /* FreeBSD Partition ID */
 51         OPENBSD_PARTITION = 0xa6,       /* OpenBSD Partition ID */
 52         NETBSD_PARTITION = 0xa9,        /* NetBSD Partition ID */
 53         BSDI_PARTITION = 0xb7,          /* BSDI Partition ID */
 54         MINIX_PARTITION = 0x81,         /* Minix Partition ID */
 55         UNIXWARE_PARTITION = 0x63,      /* Same as GNU_HURD and SCO Unix */
 56 };
 57 
 58 #include <linux/major.h>
 59 #include <linux/device.h>
 60 #include <linux/smp.h>
 61 #include <linux/string.h>
 62 #include <linux/fs.h>
 63 #include <linux/workqueue.h>
 64 
 65 struct partition {
 66         unsigned char boot_ind;         /* 0x80 - active */
 67         unsigned char head;             /* starting head */
 68         unsigned char sector;           /* starting sector */
 69         unsigned char cyl;              /* starting cylinder */
 70         unsigned char sys_ind;          /* What partition type */
 71         unsigned char end_head;         /* end head */
 72         unsigned char end_sector;       /* end sector */
 73         unsigned char end_cyl;          /* end cylinder */
 74         __le32 start_sect;      /* starting sector counting from 0 */
 75         __le32 nr_sects;                /* nr of sectors in partition */
 76 } __attribute__((packed));
 77 
 78 struct disk_stats {
 79         unsigned long sectors[2];       /* READs and WRITEs */
 80         unsigned long ios[2];
 81         unsigned long merges[2];
 82         unsigned long ticks[2];
 83         unsigned long io_ticks;
 84         unsigned long time_in_queue;
 85 };
 86         
 87 struct hd_struct {
 88         sector_t start_sect;
 89         sector_t nr_sects;
 90         struct device dev;
 91         struct kobject *holder_dir;
 92         int policy, partno;
 93 #ifdef CONFIG_FAIL_MAKE_REQUEST
 94         int make_it_fail;
 95 #endif
 96         unsigned long stamp;
 97         int in_flight;
 98 #ifdef  CONFIG_SMP
 99         struct disk_stats *dkstats;
100 #else
101         struct disk_stats dkstats;
102 #endif
103 };
104 
105 #define GENHD_FL_REMOVABLE                      1
106 #define GENHD_FL_DRIVERFS                       2
107 #define GENHD_FL_MEDIA_CHANGE_NOTIFY            4
108 #define GENHD_FL_CD                             8
109 #define GENHD_FL_UP                             16
110 #define GENHD_FL_SUPPRESS_PARTITION_INFO        32
111 #define GENHD_FL_FAIL                           64
112 
113 
114 struct gendisk {
115         int major;                      /* major number of driver */
116         int first_minor;
117         int minors;                     /* maximum number of minors, =1 for
118                                          * disks that can't be partitioned. */
119         char disk_name[32];             /* name of major driver */
120         struct hd_struct **part;        /* [indexed by minor] */
121         struct block_device_operations *fops;
122         struct request_queue *queue;
123         void *private_data;
124         sector_t capacity;
125 
126         int flags;
127         struct device *driverfs_dev;  // FIXME: remove
128         struct device dev;
129         struct kobject *holder_dir;
130         struct kobject *slave_dir;
131 
132         struct timer_rand_state *random;
133         int policy;
134 
135         atomic_t sync_io;               /* RAID */
136         unsigned long stamp;
137         int in_flight;
138 #ifdef  CONFIG_SMP
139         struct disk_stats *dkstats;
140 #else
141         struct disk_stats dkstats;
142 #endif
143         struct work_struct async_notify;
144 };
145 
146 /* 
147  * Macros to operate on percpu disk statistics:
148  *
149  * The __ variants should only be called in critical sections. The full
150  * variants disable/enable preemption.
151  */
152 static inline struct hd_struct *get_part(struct gendisk *gendiskp,
153                                          sector_t sector)
154 {
155         struct hd_struct *part;
156         int i;
157         for (i = 0; i < gendiskp->minors - 1; i++) {
158                 part = gendiskp->part[i];
159                 if (part && part->start_sect <= sector
160                     && sector < part->start_sect + part->nr_sects)
161                         return part;
162         }
163         return NULL;
164 }
165 
166 #ifdef  CONFIG_SMP
167 #define __disk_stat_add(gendiskp, field, addnd)                 \
168 do {                                                            \
169         preempt_disable();                                      \
170         (per_cpu_ptr(gendiskp->dkstats,                         \
171                         smp_processor_id())->field += addnd);   \
172         preempt_enable();                                       \
173 } while (0)
174 
175 #define disk_stat_read(gendiskp, field)                                 \
176 ({                                                                      \
177         typeof(gendiskp->dkstats->field) res = 0;                       \
178         int i;                                                          \
179         for_each_possible_cpu(i)                                        \
180                 res += per_cpu_ptr(gendiskp->dkstats, i)->field;        \
181         res;                                                            \
182 })
183 
184 static inline void disk_stat_set_all(struct gendisk *gendiskp, int value)       {
185         int i;
186         for_each_possible_cpu(i)
187                 memset(per_cpu_ptr(gendiskp->dkstats, i), value,
188                                 sizeof (struct disk_stats));
189 }               
190 
191 #define __part_stat_add(part, field, addnd)                             \
192 do {                                                                    \
193         preempt_disable();                                              \
194         (per_cpu_ptr(part->dkstats, smp_processor_id())->field += addnd); \
195         preempt_enable();                                               \
196 } while (0)
197 
198 #define __all_stat_add(gendiskp, field, addnd, sector)          \
199 ({                                                              \
200         struct hd_struct *part = get_part(gendiskp, sector);    \
201         if (part)                                               \
202                 __part_stat_add(part, field, addnd);            \
203         __disk_stat_add(gendiskp, field, addnd);                \
204 })
205 
206 #define part_stat_read(part, field)                                     \
207 ({                                                                      \
208         typeof(part->dkstats->field) res = 0;                           \
209         int i;                                                          \
210         for_each_possible_cpu(i)                                        \
211                 res += per_cpu_ptr(part->dkstats, i)->field;            \
212         res;                                                            \
213 })
214 
215 static inline void part_stat_set_all(struct hd_struct *part, int value) {
216         int i;
217         for_each_possible_cpu(i)
218                 memset(per_cpu_ptr(part->dkstats, i), value,
219                        sizeof(struct disk_stats));
220 }
221                                 
222 #else /* !CONFIG_SMP */
223 #define __disk_stat_add(gendiskp, field, addnd) \
224                                 (gendiskp->dkstats.field += addnd)
225 #define disk_stat_read(gendiskp, field) (gendiskp->dkstats.field)
226 
227 static inline void disk_stat_set_all(struct gendisk *gendiskp, int value)
228 {
229         memset(&gendiskp->dkstats, value, sizeof (struct disk_stats));
230 }
231 
232 #define __part_stat_add(part, field, addnd) \
233         (part->dkstats.field += addnd)
234 
235 #define __all_stat_add(gendiskp, field, addnd, sector)          \
236 ({                                                              \
237         struct hd_struct *part = get_part(gendiskp, sector);    \
238         if (part)                                               \
239                 part->dkstats.field += addnd;                   \
240         __disk_stat_add(gendiskp, field, addnd);                \
241 })
242 
243 #define part_stat_read(part, field)     (part->dkstats.field)
244 
245 static inline void part_stat_set_all(struct hd_struct *part, int value)
246 {
247         memset(&part->dkstats, value, sizeof(struct disk_stats));
248 }
249 
250 #endif /* CONFIG_SMP */
251 
252 #define disk_stat_add(gendiskp, field, addnd)                   \
253         do {                                                    \
254                 preempt_disable();                              \
255                 __disk_stat_add(gendiskp, field, addnd);        \
256                 preempt_enable();                               \
257         } while (0)
258 
259 #define __disk_stat_dec(gendiskp, field) __disk_stat_add(gendiskp, field, -1)
260 #define disk_stat_dec(gendiskp, field) disk_stat_add(gendiskp, field, -1)
261 
262 #define __disk_stat_inc(gendiskp, field) __disk_stat_add(gendiskp, field, 1)
263 #define disk_stat_inc(gendiskp, field) disk_stat_add(gendiskp, field, 1)
264 
265 #define __disk_stat_sub(gendiskp, field, subnd) \
266                 __disk_stat_add(gendiskp, field, -subnd)
267 #define disk_stat_sub(gendiskp, field, subnd) \
268                 disk_stat_add(gendiskp, field, -subnd)
269 
270 #define part_stat_add(gendiskp, field, addnd)           \
271         do {                                            \
272                 preempt_disable();                      \
273                 __part_stat_add(gendiskp, field, addnd);\
274                 preempt_enable();                       \
275         } while (0)
276 
277 #define __part_stat_dec(gendiskp, field) __part_stat_add(gendiskp, field, -1)
278 #define part_stat_dec(gendiskp, field) part_stat_add(gendiskp, field, -1)
279 
280 #define __part_stat_inc(gendiskp, field) __part_stat_add(gendiskp, field, 1)
281 #define part_stat_inc(gendiskp, field) part_stat_add(gendiskp, field, 1)
282 
283 #define __part_stat_sub(gendiskp, field, subnd) \
284                 __part_stat_add(gendiskp, field, -subnd)
285 #define part_stat_sub(gendiskp, field, subnd) \
286                 part_stat_add(gendiskp, field, -subnd)
287 
288 #define all_stat_add(gendiskp, field, addnd, sector)            \
289         do {                                                    \
290                 preempt_disable();                              \
291                 __all_stat_add(gendiskp, field, addnd, sector); \
292                 preempt_enable();                               \
293         } while (0)
294 
295 #define __all_stat_dec(gendiskp, field, sector) \
296                 __all_stat_add(gendiskp, field, -1, sector)
297 #define all_stat_dec(gendiskp, field, sector) \
298                 all_stat_add(gendiskp, field, -1, sector)
299 
300 #define __all_stat_inc(gendiskp, field, sector) \
301                 __all_stat_add(gendiskp, field, 1, sector)
302 #define all_stat_inc(gendiskp, field, sector) \
303                 all_stat_add(gendiskp, field, 1, sector)
304 
305 #define __all_stat_sub(gendiskp, field, subnd, sector) \
306                 __all_stat_add(gendiskp, field, -subnd, sector)
307 #define all_stat_sub(gendiskp, field, subnd, sector) \
308                 all_stat_add(gendiskp, field, -subnd, sector)
309 
310 /* Inlines to alloc and free disk stats in struct gendisk */
311 #ifdef  CONFIG_SMP
312 static inline int init_disk_stats(struct gendisk *disk)
313 {
314         disk->dkstats = alloc_percpu(struct disk_stats);
315         if (!disk->dkstats)
316                 return 0;
317         return 1;
318 }
319 
320 static inline void free_disk_stats(struct gendisk *disk)
321 {
322         free_percpu(disk->dkstats);
323 }
324 
325 static inline int init_part_stats(struct hd_struct *part)
326 {
327         part->dkstats = alloc_percpu(struct disk_stats);
328         if (!part->dkstats)
329                 return 0;
330         return 1;
331 }
332 
333 static inline void free_part_stats(struct hd_struct *part)
334 {
335         free_percpu(part->dkstats);
336 }
337 
338 #else   /* CONFIG_SMP */
339 static inline int init_disk_stats(struct gendisk *disk)
340 {
341         return 1;
342 }
343 
344 static inline void free_disk_stats(struct gendisk *disk)
345 {
346 }
347 
348 static inline int init_part_stats(struct hd_struct *part)
349 {
350         return 1;
351 }
352 
353 static inline void free_part_stats(struct hd_struct *part)
354 {
355 }
356 #endif  /* CONFIG_SMP */
357 
358 /* drivers/block/ll_rw_blk.c */
359 extern void disk_round_stats(struct gendisk *disk);
360 extern void part_round_stats(struct hd_struct *part);
361 
362 /* drivers/block/genhd.c */
363 extern int get_blkdev_list(char *, int);
364 extern void add_disk(struct gendisk *disk);
365 extern void del_gendisk(struct gendisk *gp);
366 extern void unlink_gendisk(struct gendisk *gp);
367 extern struct gendisk *get_gendisk(dev_t dev, int *part);
368 
369 extern void set_device_ro(struct block_device *bdev, int flag);
370 extern void set_disk_ro(struct gendisk *disk, int flag);
371 
372 /* drivers/char/random.c */
373 extern void add_disk_randomness(struct gendisk *disk);
374 extern void rand_initialize_disk(struct gendisk *disk);
375 
376 static inline sector_t get_start_sect(struct block_device *bdev)
377 {
378         return bdev->bd_contains == bdev ? 0 : bdev->bd_part->start_sect;
379 }
380 static inline sector_t get_capacity(struct gendisk *disk)
381 {
382         return disk->capacity;
383 }
384 static inline void set_capacity(struct gendisk *disk, sector_t size)
385 {
386         disk->capacity = size;
387 }
388 
389 #ifdef CONFIG_SOLARIS_X86_PARTITION
390 
391 #define SOLARIS_X86_NUMSLICE    16
392 #define SOLARIS_X86_VTOC_SANE   (0x600DDEEEUL)
393 
394 struct solaris_x86_slice {
395         __le16 s_tag;           /* ID tag of partition */
396         __le16 s_flag;          /* permission flags */
397         __le32 s_start;         /* start sector no of partition */
398         __le32 s_size;          /* # of blocks in partition */
399 };
400 
401 struct solaris_x86_vtoc {
402         unsigned int v_bootinfo[3];     /* info needed by mboot (unsupported) */
403         __le32 v_sanity;                /* to verify vtoc sanity */
404         __le32 v_version;               /* layout version */
405         char    v_volume[8];            /* volume name */
406         __le16  v_sectorsz;             /* sector size in bytes */
407         __le16  v_nparts;               /* number of partitions */
408         unsigned int v_reserved[10];    /* free space */
409         struct solaris_x86_slice
410                 v_slice[SOLARIS_X86_NUMSLICE]; /* slice headers */
411         unsigned int timestamp[SOLARIS_X86_NUMSLICE]; /* timestamp (unsupported) */
412         char    v_asciilabel[128];      /* for compatibility */
413 };
414 
415 #endif /* CONFIG_SOLARIS_X86_PARTITION */
416 
417 #ifdef CONFIG_BSD_DISKLABEL
418 /*
419  * BSD disklabel support by Yossi Gottlieb <yogo@math.tau.ac.il>
420  * updated by Marc Espie <Marc.Espie@openbsd.org>
421  */
422 
423 /* check against BSD src/sys/sys/disklabel.h for consistency */
424 
425 #define BSD_DISKMAGIC   (0x82564557UL)  /* The disk magic number */
426 #define BSD_MAXPARTITIONS       16
427 #define OPENBSD_MAXPARTITIONS   16
428 #define BSD_FS_UNUSED           0       /* disklabel unused partition entry ID */
429 struct bsd_disklabel {
430         __le32  d_magic;                /* the magic number */
431         __s16   d_type;                 /* drive type */
432         __s16   d_subtype;              /* controller/d_type specific */
433         char    d_typename[16];         /* type name, e.g. "eagle" */
434         char    d_packname[16];                 /* pack identifier */ 
435         __u32   d_secsize;              /* # of bytes per sector */
436         __u32   d_nsectors;             /* # of data sectors per track */
437         __u32   d_ntracks;              /* # of tracks per cylinder */
438         __u32   d_ncylinders;           /* # of data cylinders per unit */
439         __u32   d_secpercyl;            /* # of data sectors per cylinder */
440         __u32   d_secperunit;           /* # of data sectors per unit */
441         __u16   d_sparespertrack;       /* # of spare sectors per track */
442         __u16   d_sparespercyl;         /* # of spare sectors per cylinder */
443         __u32   d_acylinders;           /* # of alt. cylinders per unit */
444         __u16   d_rpm;                  /* rotational speed */
445         __u16   d_interleave;           /* hardware sector interleave */
446         __u16   d_trackskew;            /* sector 0 skew, per track */
447         __u16   d_cylskew;              /* sector 0 skew, per cylinder */
448         __u32   d_headswitch;           /* head switch time, usec */
449         __u32   d_trkseek;              /* track-to-track seek, usec */
450         __u32   d_flags;                /* generic flags */
451 #define NDDATA 5
452         __u32   d_drivedata[NDDATA];    /* drive-type specific information */
453 #define NSPARE 5
454         __u32   d_spare[NSPARE];        /* reserved for future use */
455         __le32  d_magic2;               /* the magic number (again) */
456         __le16  d_checksum;             /* xor of data incl. partitions */
457 
458                         /* filesystem and partition information: */
459         __le16  d_npartitions;          /* number of partitions in following */
460         __le32  d_bbsize;               /* size of boot area at sn0, bytes */
461         __le32  d_sbsize;               /* max size of fs superblock, bytes */
462         struct  bsd_partition {         /* the partition table */
463                 __le32  p_size;         /* number of sectors in partition */
464                 __le32  p_offset;       /* starting sector */
465                 __le32  p_fsize;        /* filesystem basic fragment size */
466                 __u8    p_fstype;       /* filesystem type, see below */
467                 __u8    p_frag;         /* filesystem fragments per block */
468                 __le16  p_cpg;          /* filesystem cylinders per group */
469         } d_partitions[BSD_MAXPARTITIONS];      /* actually may be more */
470 };
471 
472 #endif  /* CONFIG_BSD_DISKLABEL */
473 
474 #ifdef CONFIG_UNIXWARE_DISKLABEL
475 /*
476  * Unixware slices support by Andrzej Krzysztofowicz <ankry@mif.pg.gda.pl>
477  * and Krzysztof G. Baranowski <kgb@knm.org.pl>
478  */
479 
480 #define UNIXWARE_DISKMAGIC     (0xCA5E600DUL)   /* The disk magic number */
481 #define UNIXWARE_DISKMAGIC2    (0x600DDEEEUL)   /* The slice table magic nr */
482 #define UNIXWARE_NUMSLICE      16
483 #define UNIXWARE_FS_UNUSED     0                /* Unused slice entry ID */
484 
485 struct unixware_slice {
486         __le16   s_label;       /* label */
487         __le16   s_flags;       /* permission flags */
488         __le32   start_sect;    /* starting sector */
489         __le32   nr_sects;      /* number of sectors in slice */
490 };
491 
492 struct unixware_disklabel {
493         __le32   d_type;                /* drive type */
494         __le32   d_magic;                /* the magic number */
495         __le32   d_version;              /* version number */
496         char    d_serial[12];           /* serial number of the device */
497         __le32   d_ncylinders;           /* # of data cylinders per device */
498         __le32   d_ntracks;              /* # of tracks per cylinder */
499         __le32   d_nsectors;             /* # of data sectors per track */
500         __le32   d_secsize;              /* # of bytes per sector */
501         __le32   d_part_start;           /* # of first sector of this partition */
502         __le32   d_unknown1[12];         /* ? */
503         __le32  d_alt_tbl;              /* byte offset of alternate table */
504         __le32  d_alt_len;              /* byte length of alternate table */
505         __le32  d_phys_cyl;             /* # of physical cylinders per device */
506         __le32  d_phys_trk;             /* # of physical tracks per cylinder */
507         __le32  d_phys_sec;             /* # of physical sectors per track */
508         __le32  d_phys_bytes;           /* # of physical bytes per sector */
509         __le32  d_unknown2;             /* ? */
510         __le32   d_unknown3;             /* ? */
511         __le32  d_pad[8];               /* pad */
512 
513         struct unixware_vtoc {
514                 __le32  v_magic;                /* the magic number */
515                 __le32  v_version;              /* version number */
516                 char    v_name[8];              /* volume name */
517                 __le16  v_nslices;              /* # of slices */
518                 __le16  v_unknown1;             /* ? */
519                 __le32  v_reserved[10];         /* reserved */
520                 struct unixware_slice
521                         v_slice[UNIXWARE_NUMSLICE];     /* slice headers */
522         } vtoc;
523 
524 };  /* 408 */
525 
526 #endif /* CONFIG_UNIXWARE_DISKLABEL */
527 
528 #ifdef CONFIG_MINIX_SUBPARTITION
529 #   define MINIX_NR_SUBPARTITIONS  4
530 #endif /* CONFIG_MINIX_SUBPARTITION */
531 
532 #define ADDPART_FLAG_NONE       0
533 #define ADDPART_FLAG_RAID       1
534 #define ADDPART_FLAG_WHOLEDISK  2
535 
536 extern dev_t blk_lookup_devt(const char *name);
537 extern char *disk_name (struct gendisk *hd, int part, char *buf);
538 
539 extern int rescan_partitions(struct gendisk *disk, struct block_device *bdev);
540 extern void add_partition(struct gendisk *, int, sector_t, sector_t, int);
541 extern void delete_partition(struct gendisk *, int);
542 extern void printk_all_partitions(void);
543 
544 extern struct gendisk *alloc_disk_node(int minors, int node_id);
545 extern struct gendisk *alloc_disk(int minors);
546 extern struct kobject *get_disk(struct gendisk *disk);
547 extern void put_disk(struct gendisk *disk);
548 extern void blk_register_region(dev_t devt, unsigned long range,
549                         struct module *module,
550                         struct kobject *(*probe)(dev_t, int *, void *),
551                         int (*lock)(dev_t, void *),
552                         void *data);
553 extern void blk_unregister_region(dev_t devt, unsigned long range);
554 
555 static inline struct block_device *bdget_disk(struct gendisk *disk, int index)
556 {
557         return bdget(MKDEV(disk->major, disk->first_minor) + index);
558 }
559 
560 #else /* CONFIG_BLOCK */
561 
562 static inline void printk_all_partitions(void) { }
563 
564 static inline dev_t blk_lookup_devt(const char *name)
565 {
566         dev_t devt = MKDEV(0, 0);
567         return devt;
568 }
569 
570 #endif /* CONFIG_BLOCK */
571 
572 #endif /* _LINUX_GENHD_H */
573 
  This page was automatically generated by the LXR engine.