drivers/s390/block/xpram.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Xpram.c -- the S/390 expanded memory RAM-disk
   4  *
   5  * significant parts of this code are based on
   6  * the sbull device driver presented in
   7  * A. Rubini: Linux Device Drivers
   8  *
   9  * Author of XPRAM specific coding: Reinhard Buendgen
  10  *                                  buendgen@de.ibm.com
  11  * Rewrite for 2.5: Martin Schwidefsky <schwidefsky@de.ibm.com>
  12  *
  13  * External interfaces:
  14  *   Interfaces to linux kernel
  15  *        xpram_setup: read kernel parameters
  16  *   Device specific file operations
  17  *        xpram_iotcl
  18  *        xpram_open
  19  *
  20  * "ad-hoc" partitioning:
  21  *    the expanded memory can be partitioned among several devices
  22  *    (with different minors). The partitioning set up can be
  23  *    set by kernel or module parameters (int devs & int sizes[])
  24  *
  25  * Potential future improvements:
  26  *   generic hard disk support to replace ad-hoc partitioning
  27  */
  28
  29 #define KMSG_COMPONENT "xpram"
  30 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
  31
  32 #include <linux/module.h>
  33 #include <linux/moduleparam.h>
  34 #include <linux/ctype.h>  /* isdigit, isxdigit */
  35 #include <linux/errno.h>
  36 #include <linux/init.h>
  37 #include <linux/blkdev.h>
  38 #include <linux/blkpg.h>
  39 #include <linux/hdreg.h>  /* HDIO_GETGEO */
  40 #include <linux/device.h>
  41 #include <linux/bio.h>
  42 #include <linux/gfp.h>
  43 #include <linux/uaccess.h>
  44
  45 #define XPRAM_NAME      "xpram"
  46 #define XPRAM_DEVS      1       /* one partition */
  47 #define XPRAM_MAX_DEVS  32      /* maximal number of devices (partitions) */
  48
  49 typedef struct {
  50         unsigned int    size;           /* size of xpram segment in pages */
  51         unsigned int    offset;         /* start page of xpram segment */
  52 } xpram_device_t;
  53
  54 static xpram_device_t xpram_devices[XPRAM_MAX_DEVS];
  55 static unsigned int xpram_sizes[XPRAM_MAX_DEVS];
  56 static struct gendisk *xpram_disks[XPRAM_MAX_DEVS];
  57 static unsigned int xpram_pages;
  58 static int xpram_devs;
  59
  60 /*
  61  * Parameter parsing functions.
  62  */
  63 static int devs = XPRAM_DEVS;
  64 static char *sizes[XPRAM_MAX_DEVS];
  65
  66 module_param(devs, int, 0);
  67 module_param_array(sizes, charp, NULL, 0);
  68
  69 MODULE_PARM_DESC(devs, "number of devices (\"partitions\"), " \
  70                  "the default is " __MODULE_STRING(XPRAM_DEVS) "\n");
  71 MODULE_PARM_DESC(sizes, "list of device (partition) sizes " \
  72                  "the defaults are 0s \n" \
  73                  "All devices with size 0 equally partition the "
  74                  "remaining space on the expanded strorage not "
  75                  "claimed by explicit sizes\n");
  76 MODULE_LICENSE("GPL");
  77
  78 /*
  79  * Copy expanded memory page (4kB) into main memory
  80  * Arguments
  81  *           page_addr:    address of target page
  82  *           xpage_index:  index of expandeded memory page
  83  * Return value
  84  *           0:            if operation succeeds
  85  *           -EIO:         if pgin failed
  86  *           -ENXIO:       if xpram has vanished
  87  */
  88 static int xpram_page_in (unsigned long page_addr, unsigned int xpage_index)
  89 {
  90         int cc = 2;     /* return unused cc 2 if pgin traps */
  91
  92         asm volatile(
  93                 "       .insn   rre,0xb22e0000,%1,%2\n"  /* pgin %1,%2 */
  94                 "0:     ipm     %0\n"
  95                 "       srl     %0,28\n"
  96                 "1:\n"
  97                 EX_TABLE(0b,1b)
  98                 : "+d" (cc) : "a" (__pa(page_addr)), "d" (xpage_index) : "cc");
  99         if (cc == 3)
 100                 return -ENXIO;
 101         if (cc == 2)
 102                 return -ENXIO;
 103         if (cc == 1)
 104                 return -EIO;
 105         return 0;
 106 }
 107
 108 /*
 109  * Copy a 4kB page of main memory to an expanded memory page
 110  * Arguments
 111  *           page_addr:    address of source page
 112  *           xpage_index:  index of expandeded memory page
 113  * Return value
 114  *           0:            if operation succeeds
 115  *           -EIO:         if pgout failed
 116  *           -ENXIO:       if xpram has vanished
 117  */
 118 static long xpram_page_out (unsigned long page_addr, unsigned int xpage_index)
 119 {
 120         int cc = 2;     /* return unused cc 2 if pgin traps */
 121
 122         asm volatile(
 123                 "       .insn   rre,0xb22f0000,%1,%2\n"  /* pgout %1,%2 */
 124                 "0:     ipm     %0\n"
 125                 "       srl     %0,28\n"
 126                 "1:\n"
 127                 EX_TABLE(0b,1b)
 128                 : "+d" (cc) : "a" (__pa(page_addr)), "d" (xpage_index) : "cc");
 129         if (cc == 3)
 130                 return -ENXIO;
 131         if (cc == 2)
 132                 return -ENXIO;
 133         if (cc == 1)
 134                 return -EIO;
 135         return 0;
 136 }
 137
 138 /*
 139  * Check if xpram is available.
 140  */
 141 static int __init xpram_present(void)
 142 {
 143         unsigned long mem_page;
 144         int rc;
 145
 146         mem_page = (unsigned long) __get_free_page(GFP_KERNEL);
 147         if (!mem_page)
 148                 return -ENOMEM;
 149         rc = xpram_page_in(mem_page, 0);
 150         free_page(mem_page);
 151         return rc ? -ENXIO : 0;
 152 }
 153
 154 /*
 155  * Return index of the last available xpram page.
 156  */
 157 static unsigned long __init xpram_highest_page_index(void)
 158 {
 159         unsigned int page_index, add_bit;
 160         unsigned long mem_page;
 161
 162         mem_page = (unsigned long) __get_free_page(GFP_KERNEL);
 163         if (!mem_page)
 164                 return 0;
 165
 166         page_index = 0;
 167         add_bit = 1ULL << (sizeof(unsigned int)*8 - 1);
 168         while (add_bit > 0) {
 169                 if (xpram_page_in(mem_page, page_index | add_bit) == 0)
 170                         page_index |= add_bit;
 171                 add_bit >>= 1;
 172         }
 173
 174         free_page (mem_page);
 175
 176         return page_index;
 177 }
 178
 179 /*
 180  * Block device make request function.
 181  */
 182 static blk_qc_t xpram_submit_bio(struct bio *bio)
 183 {
 184         xpram_device_t *xdev = bio->bi_bdev->bd_disk->private_data;
 185         struct bio_vec bvec;
 186         struct bvec_iter iter;
 187         unsigned int index;
 188         unsigned long page_addr;
 189         unsigned long bytes;
 190
 191         blk_queue_split(&bio);
 192
 193         if ((bio->bi_iter.bi_sector & 7) != 0 ||
 194             (bio->bi_iter.bi_size & 4095) != 0)
 195                 /* Request is not page-aligned. */
 196                 goto fail;
 197         if ((bio->bi_iter.bi_size >> 12) > xdev->size)
 198                 /* Request size is no page-aligned. */
 199                 goto fail;
 200         if ((bio->bi_iter.bi_sector >> 3) > 0xffffffffU - xdev->offset)
 201                 goto fail;
 202         index = (bio->bi_iter.bi_sector >> 3) + xdev->offset;
 203         bio_for_each_segment(bvec, bio, iter) {
 204                 page_addr = (unsigned long)
 205                         kmap(bvec.bv_page) + bvec.bv_offset;
 206                 bytes = bvec.bv_len;
 207                 if ((page_addr & 4095) != 0 || (bytes & 4095) != 0)
 208                         /* More paranoia. */
 209                         goto fail;
 210                 while (bytes > 0) {
 211                         if (bio_data_dir(bio) == READ) {
 212                                 if (xpram_page_in(page_addr, index) != 0)
 213                                         goto fail;
 214                         } else {
 215                                 if (xpram_page_out(page_addr, index) != 0)
 216                                         goto fail;
 217                         }
 218                         page_addr += 4096;
 219                         bytes -= 4096;
 220                         index++;
 221                 }
 222         }
 223         bio_endio(bio);
 224         return BLK_QC_T_NONE;
 225 fail:
 226         bio_io_error(bio);
 227         return BLK_QC_T_NONE;
 228 }
 229
 230 static int xpram_getgeo(struct block_device *bdev, struct hd_geometry *geo)
 231 {
 232         unsigned long size;
 233
 234         /*
 235          * get geometry: we have to fake one...  trim the size to a
 236          * multiple of 64 (32k): tell we have 16 sectors, 4 heads,
 237          * whatever cylinders. Tell also that data starts at sector. 4.
 238          */
 239         size = (xpram_pages * 8) & ~0x3f;
 240         geo->cylinders = size >> 6;
 241         geo->heads = 4;
 242         geo->sectors = 16;
 243         geo->start = 4;
 244         return 0;
 245 }
 246
 247 static const struct block_device_operations xpram_devops =
 248 {
 249         .owner  = THIS_MODULE,
 250         .submit_bio = xpram_submit_bio,
 251         .getgeo = xpram_getgeo,
 252 };
 253
 254 /*
 255  * Setup xpram_sizes array.
 256  */
 257 static int __init xpram_setup_sizes(unsigned long pages)
 258 {
 259         unsigned long mem_needed;
 260         unsigned long mem_auto;
 261         unsigned long long size;
 262         char *sizes_end;
 263         int mem_auto_no;
 264         int i;
 265
 266         /* Check number of devices. */
 267         if (devs <= 0 || devs > XPRAM_MAX_DEVS) {
 268                 pr_err("%d is not a valid number of XPRAM devices\n",devs);
 269                 return -EINVAL;
 270         }
 271         xpram_devs = devs;
 272
 273         /*
 274          * Copy sizes array to xpram_sizes and align partition
 275          * sizes to page boundary.
 276          */
 277         mem_needed = 0;
 278         mem_auto_no = 0;
 279         for (i = 0; i < xpram_devs; i++) {
 280                 if (sizes[i]) {
 281                         size = simple_strtoull(sizes[i], &sizes_end, 0);
 282                         switch (*sizes_end) {
 283                         case 'g':
 284                         case 'G':
 285                                 size <<= 20;
 286                                 break;
 287                         case 'm':
 288                         case 'M':
 289                                 size <<= 10;
 290                         }
 291                         xpram_sizes[i] = (size + 3) & -4UL;
 292                 }
 293                 if (xpram_sizes[i])
 294                         mem_needed += xpram_sizes[i];
 295                 else
 296                         mem_auto_no++;
 297         }
 298
 299         pr_info("  number of devices (partitions): %d \n", xpram_devs);
 300         for (i = 0; i < xpram_devs; i++) {
 301                 if (xpram_sizes[i])
 302                         pr_info("  size of partition %d: %u kB\n",
 303                                 i, xpram_sizes[i]);
 304                 else
 305                         pr_info("  size of partition %d to be set "
 306                                 "automatically\n",i);
 307         }
 308         pr_info("  memory needed (for sized partitions): %lu kB\n",
 309                 mem_needed);
 310         pr_info("  partitions to be sized automatically: %d\n",
 311                 mem_auto_no);
 312
 313         if (mem_needed > pages * 4) {
 314                 pr_err("Not enough expanded memory available\n");
 315                 return -EINVAL;
 316         }
 317
 318         /*
 319          * partitioning:
 320          * xpram_sizes[i] != 0; partition i has size xpram_sizes[i] kB
 321          * else:             ; all partitions with zero xpram_sizes[i]
 322          *                     partition equally the remaining space
 323          */
 324         if (mem_auto_no) {
 325                 mem_auto = ((pages - mem_needed / 4) / mem_auto_no) * 4;
 326                 pr_info("  automatically determined "
 327                         "partition size: %lu kB\n", mem_auto);
 328                 for (i = 0; i < xpram_devs; i++)
 329                         if (xpram_sizes[i] == 0)
 330                                 xpram_sizes[i] = mem_auto;
 331         }
 332         return 0;
 333 }
 334
 335 static int __init xpram_setup_blkdev(void)
 336 {
 337         unsigned long offset;
 338         int i, rc = -ENOMEM;
 339
 340         for (i = 0; i < xpram_devs; i++) {
 341                 xpram_disks[i] = blk_alloc_disk(NUMA_NO_NODE);
 342                 if (!xpram_disks[i])
 343                         goto out;
 344                 blk_queue_flag_set(QUEUE_FLAG_NONROT, xpram_disks[i]->queue);
 345                 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM,
 346                                 xpram_disks[i]->queue);
 347                 blk_queue_logical_block_size(xpram_disks[i]->queue, 4096);
 348         }
 349
 350         /*
 351          * Register xpram major.
 352          */
 353         rc = register_blkdev(XPRAM_MAJOR, XPRAM_NAME);
 354         if (rc < 0)
 355                 goto out;
 356
 357         /*
 358          * Setup device structures.
 359          */
 360         offset = 0;
 361         for (i = 0; i < xpram_devs; i++) {
 362                 struct gendisk *disk = xpram_disks[i];
 363
 364                 xpram_devices[i].size = xpram_sizes[i] / 4;
 365                 xpram_devices[i].offset = offset;
 366                 offset += xpram_devices[i].size;
 367                 disk->major = XPRAM_MAJOR;
 368                 disk->first_minor = i;
 369                 disk->minors = 1;
 370                 disk->fops = &xpram_devops;
 371                 disk->private_data = &xpram_devices[i];
 372                 sprintf(disk->disk_name, "slram%d", i);
 373                 set_capacity(disk, xpram_sizes[i] << 1);
 374                 add_disk(disk);
 375         }
 376
 377         return 0;
 378 out:
 379         while (i--)
 380                 blk_cleanup_disk(xpram_disks[i]);
 381         return rc;
 382 }
 383
 384 /*
 385  * Finally, the init/exit functions.
 386  */
 387 static void __exit xpram_exit(void)
 388 {
 389         int i;
 390         for (i = 0; i < xpram_devs; i++) {
 391                 del_gendisk(xpram_disks[i]);
 392                 blk_cleanup_disk(xpram_disks[i]);
 393         }
 394         unregister_blkdev(XPRAM_MAJOR, XPRAM_NAME);
 395 }
 396
 397 static int __init xpram_init(void)
 398 {
 399         int rc;
 400
 401         /* Find out size of expanded memory. */
 402         if (xpram_present() != 0) {
 403                 pr_err("No expanded memory available\n");
 404                 return -ENODEV;
 405         }
 406         xpram_pages = xpram_highest_page_index() + 1;
 407         pr_info("  %u pages expanded memory found (%lu KB).\n",
 408                 xpram_pages, (unsigned long) xpram_pages*4);
 409         rc = xpram_setup_sizes(xpram_pages);
 410         if (rc)
 411                 return rc;
 412         return xpram_setup_blkdev();
 413 }
 414
 415 module_init(xpram_init);
 416 module_exit(xpram_exit);