16.5. 快速參考

16.5.?快速參考

#include <linux/fs.h>
int register_blkdev(unsigned int major, const char *name);
int unregister_blkdev(unsigned int major, const char *name);

register_blkdev 注冊一個塊驅(qū)動到內(nèi)核, 并且, 可選地, 獲得一個主編號. 一個驅(qū)動可被注銷, 使用 unregister_blkdev.

struct block_device_operations 

持有大部分塊驅(qū)動的方法的結(jié)構(gòu).

#include <linux/genhd.h>
struct gendisk;

描述內(nèi)核中單個塊設(shè)備的結(jié)構(gòu).

struct gendisk *alloc_disk(int minors);
void add_disk(struct gendisk *gd);

分配 gendisk 結(jié)構(gòu)的函數(shù), 并且返回它們到系統(tǒng).

void set_capacity(struct gendisk *gd, sector_t sectors);

存儲設(shè)備能力(以 512-字節(jié))在 gendisk 結(jié)構(gòu)中.

void add_disk(struct gendisk *gd);

添加一個磁盤到內(nèi)核. 一旦調(diào)用這個函數(shù), 你的磁盤的方法可被內(nèi)核調(diào)用.

int check_disk_change(struct block_device *bdev);

一個內(nèi)核函數(shù), 檢查在給定磁盤驅(qū)動器中的介質(zhì)改變, 并且采取要求的清理動作當(dāng)檢測到這樣一個改變.

#include <linux/blkdev.h>
request_queue_t blk_init_queue(request_fn_proc *request, spinlock_t *lock);
void blk_cleanup_queue(request_queue_t *);

處理塊請求隊(duì)列的創(chuàng)建和刪除的函數(shù).

struct request *elv_next_request(request_queue_t *queue);
void end_request(struct request *req, int success);

elv_next_request 從一個請求隊(duì)列中獲得下一個請求; end_request 可用在每個簡單驅(qū)動器中來標(biāo)識一個(或部分)請求完成.

void blkdev_dequeue_request(struct request *req);
void elv_requeue_request(request_queue_t *queue, struct request *req);

從隊(duì)列中除去一個請求, 并且放回它的函數(shù)如果需要.

void blk_stop_queue(request_queue_t *queue);
void blk_start_queue(request_queue_t *queue);

如果你需要阻止對你的請求函數(shù)的進(jìn)一步調(diào)用, 調(diào)用 blk_stop_queue 來完成. 調(diào)用 blk_start_queue 來使你的請求方法被再次調(diào)用.

void blk_queue_bounce_limit(request_queue_t *queue, u64 dma_addr);
void blk_queue_max_sectors(request_queue_t *queue, unsigned short max);
void blk_queue_max_phys_segments(request_queue_t *queue, unsigned short max);
void blk_queue_max_hw_segments(request_queue_t *queue, unsigned short max);
void blk_queue_max_segment_size(request_queue_t *queue, unsigned int max);
blk_queue_segment_boundary(request_queue_t *queue, unsigned long mask);
void blk_queue_dma_alignment(request_queue_t *queue, int mask);
void blk_queue_hardsect_size(request_queue_t *queue, unsigned short max);

設(shè)置各種隊(duì)列參數(shù)的函數(shù), 來控制請求如何被創(chuàng)建給一個特殊設(shè)備; 這些參數(shù)在"隊(duì)列控制函數(shù)"一節(jié)中描述.

#include <linux/bio.h>
struct bio;

低級函數(shù), 表示一個塊 I/O 請求的一部分.

bio_sectors(struct bio *bio);
bio_data_dir(struct bio *bio);

2 個宏定義, 表示一個由 bio 結(jié)構(gòu)描述的傳送的大小和方向.

bio_for_each_segment(bvec, bio, segno);

一個偽控制結(jié)構(gòu), 用來循環(huán)組成一個 bio 結(jié)構(gòu)的各個段.

char *__bio_kmap_atomic(struct bio *bio, int i, enum km_type type);
void __bio_kunmap_atomic(char *buffer, enum km_type type);

bio_kmap_atomic 可用來創(chuàng)建一個內(nèi)核虛擬地址給一個在 bio 結(jié)構(gòu)中的給定的段. 映射必須使用 bio_kunmap_atomic 來恢復(fù).

struct page *bio_page(struct bio *bio);
int bio_offset(struct bio *bio);int bio_cur_sectors(struct bio *bio);
char *bio_data(struct bio *bio);
char *bio_kmap_irq(struct bio *bio, unsigned long *flags);
void bio_kunmap_irq(char *buffer, unsigned long *flags);

一組存取者宏定義, 提供對一個 bio 結(jié)構(gòu)中的"當(dāng)前"段的存取.

void blk_queue_ordered(request_queue_t *queue, int flag);
int blk_barrier_rq(struct request *req);

如果你的驅(qū)動實(shí)現(xiàn)屏障請求, 調(diào)用 blk_queue_ordered -- 如同它應(yīng)當(dāng)做的. 宏 blk_barrier_rq 返回一個非零值如果當(dāng)前請求是一個屏障請求.

int blk_noretry_request(struct request *req);

這個宏返回一個非零值, 如果給定的請求不應(yīng)當(dāng)在出錯時重新嘗試.

int end_that_request_first(struct request *req, int success, int count);
void end_that_request_last(struct request *req);

使用 end_that_request_firest 來指示一個塊 I/O 請求的一部分完成. 當(dāng)那個函數(shù)返回 0, 請求完成并且應(yīng)當(dāng)被傳遞給 end_that_request_last.

rq_for_each_bio(bio, request)

另一個用宏定義來實(shí)現(xiàn)的控制結(jié)構(gòu); 它步入構(gòu)成一個請求的每個 bio.

int blk_rq_map_sg(request_queue_t *queue, struct request *req, struct scatterlist *list);

為一次 DMA 傳送填充給定的散布表, 用需要來映射給定請求中的緩沖的信息

typedef int (make_request_fn) (request_queue_t *q, struct bio *bio);

make_request 函數(shù)的原型.

void bio_endio(struct bio *bio, unsigned int bytes, int error);

指示一個給定 bio 的完成. 這個函數(shù)應(yīng)當(dāng)只用在你的驅(qū)動直接獲取 bio , 通過 make_request 函數(shù)從塊層.

request_queue_t *blk_alloc_queue(int flags);
void blk_queue_make_request(request_queue_t *queue, make_request_fn *func);

使用 blk_alloc_queue 來分配由定制的 make_request 函數(shù)使用的請求隊(duì)列, . 那個函數(shù)應(yīng)當(dāng)使用 blk_queue_make_request 來設(shè)置.

typedef int (prep_rq_fn) (request_queue_t *queue, struct request *req);
void blk_queue_prep_rq(request_queue_t *queue, prep_rq_fn *func);

一個命令準(zhǔn)備函數(shù)的原型和設(shè)置函數(shù), 它可用來準(zhǔn)備必要的硬件命令, 在請求被傳遞給你的請求函數(shù)之前.

int blk_queue_init_tags(request_queue_t *queue, int depth, struct blk_queue_tag *tags);
int blk_queue_resize_tags(request_queue_t *queue, int new_depth);
int blk_queue_start_tag(request_queue_t *queue, struct request *req);
void blk_queue_end_tag(request_queue_t *queue, struct request *req);
struct request *blk_queue_find_tag(request_queue_t *qeue, int tag);void blk_queue_invalidate_tags(request_queue_t *queue);

驅(qū)動使用被標(biāo)記的命令隊(duì)列的支持函數(shù).