[mirror_ubuntu-bionic-kernel.git] / drivers / block / rsxx / dev.c

/*
* Filename: dev.c
*
*
* Authors: Joshua Morris <josh.h.morris@us.ibm.com>
*	Philip Kelleher <pjk1939@linux.vnet.ibm.com>
*
* (C) Copyright 2013 IBM Corporation
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/

#include <linux/kernel.h>
#include <linux/interrupt.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/slab.h>

#include <linux/hdreg.h>
#include <linux/genhd.h>
#include <linux/blkdev.h>
#include <linux/bio.h>

#include <linux/fs.h>

#include "rsxx_priv.h"

static unsigned int blkdev_minors = 64;
module_param(blkdev_minors, uint, 0444);
MODULE_PARM_DESC(blkdev_minors, "Number of minors(partitions)");

/*
 * For now I'm making this tweakable in case any applications hit this limit.
 * If you see a "bio too big" error in the log you will need to raise this
 * value.
 */
static unsigned int blkdev_max_hw_sectors = 1024;
module_param(blkdev_max_hw_sectors, uint, 0444);
MODULE_PARM_DESC(blkdev_max_hw_sectors, "Max hw sectors for a single BIO");

static unsigned int enable_blkdev = 1;
module_param(enable_blkdev , uint, 0444);
MODULE_PARM_DESC(enable_blkdev, "Enable block device interfaces");


struct rsxx_bio_meta {
	struct bio	*bio;
	atomic_t	pending_dmas;
	atomic_t	error;
	unsigned long	start_time;
};

static struct kmem_cache *bio_meta_pool;

/*----------------- Block Device Operations -----------------*/
static int rsxx_blkdev_ioctl(struct block_device *bdev,
				 fmode_t mode,
				 unsigned int cmd,
				 unsigned long arg)
{
	struct rsxx_cardinfo *card = bdev->bd_disk->private_data;

	switch (cmd) {
	case RSXX_GETREG:
		return rsxx_reg_access(card, (void __user *)arg, 1);
	case RSXX_SETREG:
		return rsxx_reg_access(card, (void __user *)arg, 0);
	}

	return -ENOTTY;
}

static int rsxx_getgeo(struct block_device *bdev, struct hd_geometry *geo)
{
	struct rsxx_cardinfo *card = bdev->bd_disk->private_data;
	u64 blocks = card->size8 >> 9;

	/*
	 * get geometry: Fake it. I haven't found any drivers that set
	 * geo->start, so we won't either.
	 */
	if (card->size8) {
		geo->heads = 64;
		geo->sectors = 16;
		do_div(blocks, (geo->heads * geo->sectors));
		geo->cylinders = blocks;
	} else {
		geo->heads = 0;
		geo->sectors = 0;
		geo->cylinders = 0;
	}
	return 0;
}

static const struct block_device_operations rsxx_fops = {
	.owner		= THIS_MODULE,
	.getgeo		= rsxx_getgeo,
	.ioctl		= rsxx_blkdev_ioctl,
};

static void disk_stats_start(struct rsxx_cardinfo *card, struct bio *bio)
{
	generic_start_io_acct(bio_data_dir(bio), bio_sectors(bio),
			     &card->gendisk->part0);
}

static void disk_stats_complete(struct rsxx_cardinfo *card,
				struct bio *bio,
				unsigned long start_time)
{
	generic_end_io_acct(bio_data_dir(bio), &card->gendisk->part0,
			   start_time);
}

static void bio_dma_done_cb(struct rsxx_cardinfo *card,
			    void *cb_data,
			    unsigned int error)
{
	struct rsxx_bio_meta *meta = cb_data;

	if (error)
		atomic_set(&meta->error, 1);

	if (atomic_dec_and_test(&meta->pending_dmas)) {
		if (!card->eeh_state && card->gendisk)
			disk_stats_complete(card, meta->bio, meta->start_time);

		if (atomic_read(&meta->error))
			bio_io_error(meta->bio);
		else
			bio_endio(meta->bio);
		kmem_cache_free(bio_meta_pool, meta);
	}
}

static blk_qc_t rsxx_make_request(struct request_queue *q, struct bio *bio)
{
	struct rsxx_cardinfo *card = q->queuedata;
	struct rsxx_bio_meta *bio_meta;
	int st = -EINVAL;

	blk_queue_split(q, &bio, q->bio_split);

	might_sleep();

	if (!card)
		goto req_err;

	if (bio_end_sector(bio) > get_capacity(card->gendisk))
		goto req_err;

	if (unlikely(card->halt)) {
		st = -EFAULT;
		goto req_err;
	}

	if (unlikely(card->dma_fault)) {
		st = (-EFAULT);
		goto req_err;
	}

	if (bio->bi_iter.bi_size == 0) {
		dev_err(CARD_TO_DEV(card), "size zero BIO!\n");
		goto req_err;
	}

	bio_meta = kmem_cache_alloc(bio_meta_pool, GFP_KERNEL);
	if (!bio_meta) {
		st = -ENOMEM;
		goto req_err;
	}

	bio_meta->bio = bio;
	atomic_set(&bio_meta->error, 0);
	atomic_set(&bio_meta->pending_dmas, 0);
	bio_meta->start_time = jiffies;

	if (!unlikely(card->halt))
		disk_stats_start(card, bio);

	dev_dbg(CARD_TO_DEV(card), "BIO[%c]: meta: %p addr8: x%llx size: %d\n",
		 bio_data_dir(bio) ? 'W' : 'R', bio_meta,
		 (u64)bio->bi_iter.bi_sector << 9, bio->bi_iter.bi_size);

	st = rsxx_dma_queue_bio(card, bio, &bio_meta->pending_dmas,
				    bio_dma_done_cb, bio_meta);
	if (st)
		goto queue_err;

	return BLK_QC_T_NONE;

queue_err:
	kmem_cache_free(bio_meta_pool, bio_meta);
req_err:
	if (st)
		bio->bi_error = st;
	bio_endio(bio);
	return BLK_QC_T_NONE;
}

/*----------------- Device Setup -------------------*/
static bool rsxx_discard_supported(struct rsxx_cardinfo *card)
{
	unsigned char pci_rev;

	pci_read_config_byte(card->dev, PCI_REVISION_ID, &pci_rev);

	return (pci_rev >= RSXX_DISCARD_SUPPORT);
}

int rsxx_attach_dev(struct rsxx_cardinfo *card)
{
	mutex_lock(&card->dev_lock);

	/* The block device requires the stripe size from the config. */
	if (enable_blkdev) {
		if (card->config_valid)
			set_capacity(card->gendisk, card->size8 >> 9);
		else
			set_capacity(card->gendisk, 0);
		device_add_disk(CARD_TO_DEV(card), card->gendisk);
		card->bdev_attached = 1;
	}

	mutex_unlock(&card->dev_lock);

	return 0;
}

void rsxx_detach_dev(struct rsxx_cardinfo *card)
{
	mutex_lock(&card->dev_lock);

	if (card->bdev_attached) {
		del_gendisk(card->gendisk);
		card->bdev_attached = 0;
	}

	mutex_unlock(&card->dev_lock);
}

int rsxx_setup_dev(struct rsxx_cardinfo *card)
{
	unsigned short blk_size;

	mutex_init(&card->dev_lock);

	if (!enable_blkdev)
		return 0;

	card->major = register_blkdev(0, DRIVER_NAME);
	if (card->major < 0) {
		dev_err(CARD_TO_DEV(card), "Failed to get major number\n");
		return -ENOMEM;
	}

	card->queue = blk_alloc_queue(GFP_KERNEL);
	if (!card->queue) {
		dev_err(CARD_TO_DEV(card), "Failed queue alloc\n");
		unregister_blkdev(card->major, DRIVER_NAME);
		return -ENOMEM;
	}

	card->gendisk = alloc_disk(blkdev_minors);
	if (!card->gendisk) {
		dev_err(CARD_TO_DEV(card), "Failed disk alloc\n");
		blk_cleanup_queue(card->queue);
		unregister_blkdev(card->major, DRIVER_NAME);
		return -ENOMEM;
	}

	if (card->config_valid) {
		blk_size = card->config.data.block_size;
		blk_queue_dma_alignment(card->queue, blk_size - 1);
		blk_queue_logical_block_size(card->queue, blk_size);
	}

	blk_queue_make_request(card->queue, rsxx_make_request);
	blk_queue_bounce_limit(card->queue, BLK_BOUNCE_ANY);
	blk_queue_max_hw_sectors(card->queue, blkdev_max_hw_sectors);
	blk_queue_physical_block_size(card->queue, RSXX_HW_BLK_SIZE);

	queue_flag_set_unlocked(QUEUE_FLAG_NONROT, card->queue);
	queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, card->queue);
	if (rsxx_discard_supported(card)) {
		queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, card->queue);
		blk_queue_max_discard_sectors(card->queue,
						RSXX_HW_BLK_SIZE >> 9);
		card->queue->limits.discard_granularity = RSXX_HW_BLK_SIZE;
		card->queue->limits.discard_alignment   = RSXX_HW_BLK_SIZE;
	}

	card->queue->queuedata = card;

	snprintf(card->gendisk->disk_name, sizeof(card->gendisk->disk_name),
		 "rsxx%d", card->disk_id);
	card->gendisk->major = card->major;
	card->gendisk->first_minor = 0;
	card->gendisk->fops = &rsxx_fops;
	card->gendisk->private_data = card;
	card->gendisk->queue = card->queue;

	return 0;
}

void rsxx_destroy_dev(struct rsxx_cardinfo *card)
{
	if (!enable_blkdev)
		return;

	put_disk(card->gendisk);
	card->gendisk = NULL;

	blk_cleanup_queue(card->queue);
	card->queue->queuedata = NULL;
	unregister_blkdev(card->major, DRIVER_NAME);
}

int rsxx_dev_init(void)
{
	bio_meta_pool = KMEM_CACHE(rsxx_bio_meta, SLAB_HWCACHE_ALIGN);
	if (!bio_meta_pool)
		return -ENOMEM;

	return 0;
}

void rsxx_dev_cleanup(void)
{
	kmem_cache_destroy(bio_meta_pool);
}
Commit	Line	Data
8722ff8c	1	/*
	2	* Filename: dev.c
	3	*
	4	*
	5	* Authors: Joshua Morris <josh.h.morris@us.ibm.com>
	6	* Philip Kelleher <pjk1939@linux.vnet.ibm.com>
	7	*
	8	* (C) Copyright 2013 IBM Corporation
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public License as
	12	* published by the Free Software Foundation; either version 2 of the
	13	* License, or (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful, but
	16	* WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	18	* General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software Foundation,
	22	* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	23	*/
	24
	25	#include <linux/kernel.h>
	26	#include <linux/interrupt.h>
	27	#include <linux/module.h>
	28	#include <linux/pci.h>
	29	#include <linux/slab.h>
	30
	31	#include <linux/hdreg.h>
	32	#include <linux/genhd.h>
	33	#include <linux/blkdev.h>
	34	#include <linux/bio.h>
	35
	36	#include <linux/fs.h>
	37
	38	#include "rsxx_priv.h"
	39
	40	static unsigned int blkdev_minors = 64;
	41	module_param(blkdev_minors, uint, 0444);
	42	MODULE_PARM_DESC(blkdev_minors, "Number of minors(partitions)");
	43
	44	/*
	45	* For now I'm making this tweakable in case any applications hit this limit.
	46	* If you see a "bio too big" error in the log you will need to raise this
	47	* value.
	48	*/
	49	static unsigned int blkdev_max_hw_sectors = 1024;
	50	module_param(blkdev_max_hw_sectors, uint, 0444);
	51	MODULE_PARM_DESC(blkdev_max_hw_sectors, "Max hw sectors for a single BIO");
	52
	53	static unsigned int enable_blkdev = 1;
	54	module_param(enable_blkdev , uint, 0444);
	55	MODULE_PARM_DESC(enable_blkdev, "Enable block device interfaces");
	56
	57
	58	struct rsxx_bio_meta {
	59	struct bio *bio;
	60	atomic_t pending_dmas;
	61	atomic_t error;
	62	unsigned long start_time;
	63	};
	64
65	static struct kmem_cache *bio_meta_pool;
66
67	/----------------- Block Device Operations -----------------/
68	static int rsxx_blkdev_ioctl(struct block_device *bdev,
69	fmode_t mode,
70	unsigned int cmd,
71	unsigned long arg)
72	{
73	struct rsxx_cardinfo *card = bdev->bd_disk->private_data;
74
75	switch (cmd) {
76	case RSXX_GETREG:
77	return rsxx_reg_access(card, (void __user *)arg, 1);
78	case RSXX_SETREG:
79	return rsxx_reg_access(card, (void __user *)arg, 0);
80	}
81
82	return -ENOTTY;
83	}
84
85	static int rsxx_getgeo(struct block_device bdev, struct hd_geometry geo)
86	{
87	struct rsxx_cardinfo *card = bdev->bd_disk->private_data;
88	u64 blocks = card->size8 >> 9;
89
90	/*
91	* get geometry: Fake it. I haven't found any drivers that set
92	* geo->start, so we won't either.
93	*/
94	if (card->size8) {
95	geo->heads = 64;
96	geo->sectors = 16;
97	do_div(blocks, (geo->heads * geo->sectors));
98	geo->cylinders = blocks;
99	} else {
100	geo->heads = 0;
101	geo->sectors = 0;
102	geo->cylinders = 0;
103	}
104	return 0;
105	}
106
107	static const struct block_device_operations rsxx_fops = {
108	.owner = THIS_MODULE,
109	.getgeo = rsxx_getgeo,
110	.ioctl = rsxx_blkdev_ioctl,
111	};
112
113	static void disk_stats_start(struct rsxx_cardinfo card, struct bio bio)
114	{
fa573f72 GZ	115	generic_start_io_acct(bio_data_dir(bio), bio_sectors(bio),
fa573f72 GZ	116	&card->gendisk->part0);
8722ff8c	117	}
	118
	119	static void disk_stats_complete(struct rsxx_cardinfo *card,
	120	struct bio *bio,
	121	unsigned long start_time)
	122	{
fa573f72 GZ	123	generic_end_io_acct(bio_data_dir(bio), &card->gendisk->part0,
fa573f72 GZ	124	start_time);
8722ff8c	125	}
	126
	127	static void bio_dma_done_cb(struct rsxx_cardinfo *card,
	128	void *cb_data,
	129	unsigned int error)
	130	{
c206c709	131	struct rsxx_bio_meta *meta = cb_data;
8722ff8c	132
	133	if (error)
	134	atomic_set(&meta->error, 1);
	135
	136	if (atomic_dec_and_test(&meta->pending_dmas)) {
0ab4743e PK	137	if (!card->eeh_state && card->gendisk)
0ab4743e PK	138	disk_stats_complete(card, meta->bio, meta->start_time);
8722ff8c	139
4246a0b6 CH	140	if (atomic_read(&meta->error))
	141	bio_io_error(meta->bio);
	142	else
	143	bio_endio(meta->bio);
8722ff8c	144	kmem_cache_free(bio_meta_pool, meta);
	145	}
	146	}
	147
dece1635	148	static blk_qc_t rsxx_make_request(struct request_queue q, struct bio bio)
8722ff8c	149	{
	150	struct rsxx_cardinfo *card = q->queuedata;
	151	struct rsxx_bio_meta *bio_meta;
	152	int st = -EINVAL;
	153
54efd50b KO	154	blk_queue_split(q, &bio, q->bio_split);
54efd50b KO	155
8722ff8c	156	might_sleep();
8722ff8c	157
66bc6003 PK	158	if (!card)
	159	goto req_err;
	160
4f024f37	161	if (bio_end_sector(bio) > get_capacity(card->gendisk))
3eb8dcaf PK	162	goto req_err;
3eb8dcaf PK	163
8722ff8c	164	if (unlikely(card->halt)) {
	165	st = -EFAULT;
	166	goto req_err;
	167	}
	168
	169	if (unlikely(card->dma_fault)) {
	170	st = (-EFAULT);
	171	goto req_err;
	172	}
	173
4f024f37	174	if (bio->bi_iter.bi_size == 0) {
8722ff8c	175	dev_err(CARD_TO_DEV(card), "size zero BIO!\n");
	176	goto req_err;
	177	}
	178
	179	bio_meta = kmem_cache_alloc(bio_meta_pool, GFP_KERNEL);
	180	if (!bio_meta) {
	181	st = -ENOMEM;
	182	goto req_err;
	183	}
	184
	185	bio_meta->bio = bio;
	186	atomic_set(&bio_meta->error, 0);
	187	atomic_set(&bio_meta->pending_dmas, 0);
	188	bio_meta->start_time = jiffies;
	189
0ab4743e PK	190	if (!unlikely(card->halt))
0ab4743e PK	191	disk_stats_start(card, bio);
8722ff8c	192
	193	dev_dbg(CARD_TO_DEV(card), "BIO[%c]: meta: %p addr8: x%llx size: %d\n",
	194	bio_data_dir(bio) ? 'W' : 'R', bio_meta,
4f024f37	195	(u64)bio->bi_iter.bi_sector << 9, bio->bi_iter.bi_size);
8722ff8c	196
	197	st = rsxx_dma_queue_bio(card, bio, &bio_meta->pending_dmas,
	198	bio_dma_done_cb, bio_meta);
	199	if (st)
	200	goto queue_err;
	201
dece1635	202	return BLK_QC_T_NONE;
8722ff8c	203
	204	queue_err:
	205	kmem_cache_free(bio_meta_pool, bio_meta);
	206	req_err:
4246a0b6 CH	207	if (st)
	208	bio->bi_error = st;
	209	bio_endio(bio);
dece1635	210	return BLK_QC_T_NONE;
8722ff8c	211	}
	212
	213	/----------------- Device Setup -------------------/
	214	static bool rsxx_discard_supported(struct rsxx_cardinfo *card)
	215	{
	216	unsigned char pci_rev;
	217
	218	pci_read_config_byte(card->dev, PCI_REVISION_ID, &pci_rev);
	219
	220	return (pci_rev >= RSXX_DISCARD_SUPPORT);
	221	}
	222
8722ff8c	223	int rsxx_attach_dev(struct rsxx_cardinfo *card)
	224	{
	225	mutex_lock(&card->dev_lock);
	226
	227	/* The block device requires the stripe size from the config. */
	228	if (enable_blkdev) {
	229	if (card->config_valid)
	230	set_capacity(card->gendisk, card->size8 >> 9);
	231	else
	232	set_capacity(card->gendisk, 0);
0d52c756	233	device_add_disk(CARD_TO_DEV(card), card->gendisk);
8722ff8c	234	card->bdev_attached = 1;
	235	}
	236
	237	mutex_unlock(&card->dev_lock);
	238
	239	return 0;
	240	}
	241
	242	void rsxx_detach_dev(struct rsxx_cardinfo *card)
	243	{
	244	mutex_lock(&card->dev_lock);
	245
	246	if (card->bdev_attached) {
	247	del_gendisk(card->gendisk);
	248	card->bdev_attached = 0;
	249	}
	250
	251	mutex_unlock(&card->dev_lock);
	252	}
	253
	254	int rsxx_setup_dev(struct rsxx_cardinfo *card)
	255	{
	256	unsigned short blk_size;
	257
	258	mutex_init(&card->dev_lock);
	259
	260	if (!enable_blkdev)
	261	return 0;
	262
	263	card->major = register_blkdev(0, DRIVER_NAME);
	264	if (card->major < 0) {
	265	dev_err(CARD_TO_DEV(card), "Failed to get major number\n");
	266	return -ENOMEM;
	267	}
	268
	269	card->queue = blk_alloc_queue(GFP_KERNEL);
	270	if (!card->queue) {
	271	dev_err(CARD_TO_DEV(card), "Failed queue alloc\n");
	272	unregister_blkdev(card->major, DRIVER_NAME);
	273	return -ENOMEM;
	274	}
	275
	276	card->gendisk = alloc_disk(blkdev_minors);
	277	if (!card->gendisk) {
	278	dev_err(CARD_TO_DEV(card), "Failed disk alloc\n");
	279	blk_cleanup_queue(card->queue);
	280	unregister_blkdev(card->major, DRIVER_NAME);
	281	return -ENOMEM;
	282	}
	283
8c49a77c PK	284	if (card->config_valid) {
	285	blk_size = card->config.data.block_size;
	286	blk_queue_dma_alignment(card->queue, blk_size - 1);
	287	blk_queue_logical_block_size(card->queue, blk_size);
	288	}
8722ff8c	289
	290	blk_queue_make_request(card->queue, rsxx_make_request);
	291	blk_queue_bounce_limit(card->queue, BLK_BOUNCE_ANY);
8722ff8c	292	blk_queue_max_hw_sectors(card->queue, blkdev_max_hw_sectors);
8722ff8c	293	blk_queue_physical_block_size(card->queue, RSXX_HW_BLK_SIZE);
	294
	295	queue_flag_set_unlocked(QUEUE_FLAG_NONROT, card->queue);
b277da0a	296	queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, card->queue);
8722ff8c	297	if (rsxx_discard_supported(card)) {
	298	queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, card->queue);
	299	blk_queue_max_discard_sectors(card->queue,
	300	RSXX_HW_BLK_SIZE >> 9);
	301	card->queue->limits.discard_granularity = RSXX_HW_BLK_SIZE;
	302	card->queue->limits.discard_alignment = RSXX_HW_BLK_SIZE;
8722ff8c	303	}
	304
	305	card->queue->queuedata = card;
	306
	307	snprintf(card->gendisk->disk_name, sizeof(card->gendisk->disk_name),
	308	"rsxx%d", card->disk_id);
8722ff8c	309	card->gendisk->major = card->major;
	310	card->gendisk->first_minor = 0;
	311	card->gendisk->fops = &rsxx_fops;
	312	card->gendisk->private_data = card;
	313	card->gendisk->queue = card->queue;
	314
	315	return 0;
	316	}
	317
	318	void rsxx_destroy_dev(struct rsxx_cardinfo *card)
	319	{
	320	if (!enable_blkdev)
	321	return;
	322
	323	put_disk(card->gendisk);
	324	card->gendisk = NULL;
	325
	326	blk_cleanup_queue(card->queue);
66bc6003	327	card->queue->queuedata = NULL;
8722ff8c	328	unregister_blkdev(card->major, DRIVER_NAME);
	329	}
	330
	331	int rsxx_dev_init(void)
	332	{
	333	bio_meta_pool = KMEM_CACHE(rsxx_bio_meta, SLAB_HWCACHE_ALIGN);
	334	if (!bio_meta_pool)
	335	return -ENOMEM;
	336
	337	return 0;
	338	}
	339
	340	void rsxx_dev_cleanup(void)
	341	{
	342	kmem_cache_destroy(bio_meta_pool);
	343	}
	344
	345