1 /***********************license start***************
2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2003-2008 Cavium Networks (support@cavium.com). All rights
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer in the documentation and/or other materials provided
18 * with the distribution.
20 * * Neither the name of Cavium Networks nor the names of
21 * its contributors may be used to endorse or promote products
22 * derived from this software without specific prior written
25 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
26 * AND WITH ALL FAULTS AND CAVIUM NETWORKS MAKES NO PROMISES, REPRESENTATIONS
27 * OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH
28 * RESPECT TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY
29 * REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT
30 * DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES
31 * OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR
32 * PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET
33 * POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK ARISING OUT
34 * OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU.
37 * For any questions regarding licensing please contact marketing@caviumnetworks.com
39 ***********************license end**************************************/
46 #include <sys/cdefs.h>
47 __FBSDID("$FreeBSD$");
49 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/sysctl.h>
55 #include <sys/kernel.h>
56 #include <sys/module.h>
58 #include <sys/power.h>
61 #include <sys/timetc.h>
62 #include <sys/malloc.h>
64 #include <geom/geom.h>
66 #include <machine/clock.h>
67 #include <machine/locore.h>
68 #include <machine/md_var.h>
69 #include <machine/cpuregs.h>
71 #include <mips/cavium/octeon_pcmap_regs.h>
73 #include <contrib/octeon-sdk/cvmx.h>
76 #define CMD_READ_SECTOR 0x20
77 #define CMD_WRITE_SECTOR 0x30
78 #define CMD_IDENTIFY 0xEC
80 /* The ATA Task File */
83 #define TF_PRECOMP 0x01
84 #define TF_SECTOR_COUNT 0x02
85 #define TF_SECTOR_NUMBER 0x03
86 #define TF_CYL_LSB 0x04
87 #define TF_CYL_MSB 0x05
88 #define TF_DRV_HEAD 0x06
89 #define TF_STATUS 0x07
90 #define TF_COMMAND 0x07
93 #define STATUS_BSY 0x80 /* Drive is busy */
94 #define STATUS_RDY 0x40 /* Drive is ready */
95 #define STATUS_DF 0x20 /* Device fault */
96 #define STATUS_DRQ 0x08 /* Data can be transferred */
99 #define SECTOR_SIZE 512
100 #define WAIT_DELAY 1000
101 #define NR_TRIES 1000
102 #define SWAP_SHORT(x) ((x << 8) | (x >> 8))
103 #define MODEL_STR_SIZE 40
107 * There's three bus types supported by this driver.
109 * CF_8 -- Traditional PC Card IDE interface on an 8-bit wide bus. We assume
110 * the bool loader has configure attribute memory properly. We then access
111 * the device like old-school 8-bit IDE card (which is all a traditional PC Card
112 * interface really is).
113 * CF_16 -- Traditional PC Card IDE interface on a 16-bit wide bus. Registers on
114 * this bus are 16-bits wide too. When accessing registers in the task file, you
115 * have to do it in 16-bit chunks, and worry about masking out what you don't want
116 * or ORing together the traditional 8-bit values. We assume the bootloader does
117 * the right attribute memory initialization dance.
118 * CF_TRUE_IDE_8 - CF Card wired to True IDE mode. There's no Attribute memory
119 * space at all. Instead all the traditional 8-bit registers are there, but
120 * on a 16-bit bus where addr0 isn't wired. This means we need to read/write them
121 * 16-bit chunks, but only the lower 8 bits are valid. We do not (and can not)
122 * access this like CF_16 with the comingled registers. Yet we can't access
123 * this like CF_8 because of the register offset. Except the TF_DATA register
124 * appears to be full width?
128 #define CF_8 1 /* 8-bit bus, no offsets - PC Card */
129 #define CF_16 2 /* 16-bit bus, registers shared - PC Card */
130 #define CF_TRUE_IDE_8 3 /* 16-bit bus, only lower 8-bits, TrueIDE */
131 const char *const cf_type[] = {
138 /* Device parameters */
141 char buf[SECTOR_SIZE];
142 struct ata_params driveid;
145 char model[MODEL_STR_SIZE];
147 uint16_t sector_size;
156 struct drive_param drive_param;
158 struct bio_queue_head cf_bq;
159 struct g_geom *cf_geom;
160 struct g_provider *cf_provider;
164 /* GEOM class implementation */
165 static g_access_t cf_access;
166 static g_start_t cf_start;
167 static g_ioctl_t cf_ioctl;
169 struct g_class g_cf_class = {
171 .version = G_VERSION,
177 DECLARE_GEOM_CLASS(g_cf_class, g_cf);
180 static int cf_probe(device_t);
181 static void cf_identify(driver_t *, device_t);
182 static int cf_attach(device_t);
183 static void cf_attach_geom(void *, int);
186 static int cf_cmd_identify(struct cf_priv *);
187 static int cf_cmd_write(uint32_t, uint32_t, void *);
188 static int cf_cmd_read(uint32_t, uint32_t, void *);
189 static int cf_wait_busy(void);
190 static int cf_send_cmd(uint32_t, uint8_t);
193 static void cf_swap_ascii(unsigned char[], char[]);
195 /* ------------------------------------------------------------------- *
197 * ------------------------------------------------------------------- */
198 static int cf_access (struct g_provider *pp, int r, int w, int e)
203 /* ------------------------------------------------------------------- *
205 * ------------------------------------------------------------------- */
206 static void cf_start (struct bio *bp)
208 struct cf_priv *cf_priv;
211 cf_priv = bp->bio_to->geom->softc;
214 * Handle actual I/O requests. The request is passed down through
218 switch (bp->bio_cmd) {
220 if (g_handleattr_int(bp, "GEOM::fwsectors", cf_priv->drive_param.sec_track))
222 if (g_handleattr_int(bp, "GEOM::fwheads", cf_priv->drive_param.heads))
224 g_io_deliver(bp, ENOIOCTL);
228 error = cf_cmd_read(bp->bio_length / cf_priv->drive_param.sector_size,
229 bp->bio_offset / cf_priv->drive_param.sector_size, bp->bio_data);
232 error = cf_cmd_write(bp->bio_length / cf_priv->drive_param.sector_size,
233 bp->bio_offset/cf_priv->drive_param.sector_size, bp->bio_data);
237 printf("%s: unrecognized bio_cmd %x.\n", __func__, bp->bio_cmd);
243 g_io_deliver(bp, error);
248 bp->bio_completed = bp->bio_length;
252 static int cf_ioctl (struct g_provider *pp, u_long cmd, void *data, int fflag, struct thread *td)
257 static uint8_t cf_inb_8(int port)
260 * Traditional 8-bit PC Card/CF bus access.
262 if (bus_type == CF_8) {
263 volatile uint8_t *task_file = (volatile uint8_t *)base_addr;
264 return task_file[port];
268 * True IDE access. lower 8 bits on a 16-bit bus (see above).
270 volatile uint16_t *task_file = (volatile uint16_t *)base_addr;
271 return task_file[port] & 0xff;
274 static void cf_outb_8(int port, uint8_t val)
277 * Traditional 8-bit PC Card/CF bus access.
279 if (bus_type == CF_8) {
280 volatile uint8_t *task_file = (volatile uint8_t *)base_addr;
281 task_file[port] = val;
286 * True IDE access. lower 8 bits on a 16-bit bus (see above).
288 volatile uint16_t *task_file = (volatile uint16_t *)base_addr;
289 task_file[port] = val & 0xff;
292 static uint8_t cf_inb_16(int port)
294 volatile uint16_t *task_file = (volatile uint16_t *)base_addr;
295 uint16_t val = task_file[port / 2];
297 return (val >> 8) & 0xff;
301 static uint16_t cf_inw_16(int port)
303 volatile uint16_t *task_file = (volatile uint16_t *)base_addr;
304 uint16_t val = task_file[port / 2];
308 static void cf_outw_16(int port, uint16_t val)
310 volatile uint16_t *task_file = (volatile uint16_t *)base_addr;
311 task_file[port / 2] = val;
314 /* ------------------------------------------------------------------- *
316 * ------------------------------------------------------------------- *
318 * Read nr_sectors from the device starting from start_sector.
320 static int cf_cmd_read (uint32_t nr_sectors, uint32_t start_sector, void *buf)
328 ptr_8 = (uint8_t*)buf;
329 ptr_16 = (uint16_t*)buf;
332 while (nr_sectors--) {
333 error = cf_send_cmd(lba, CMD_READ_SECTOR);
335 printf("%s: cf_send_cmd(CMD_READ_SECTOR) failed: %d\n", __func__, error);
342 for (count = 0; count < SECTOR_SIZE; count++) {
343 *ptr_8++ = cf_inb_8(TF_DATA);
344 if ((count & 0xf) == 0)
345 (void)cf_inb_8(TF_STATUS);
351 for (count = 0; count < SECTOR_SIZE; count+=2) {
353 temp = cf_inw_16(TF_DATA);
354 *ptr_16++ = SWAP_SHORT(temp);
355 if ((count & 0xf) == 0)
356 (void)cf_inb_16(TF_STATUS);
366 /* ------------------------------------------------------------------- *
368 * ------------------------------------------------------------------- *
370 * Write nr_sectors to the device starting from start_sector.
372 static int cf_cmd_write (uint32_t nr_sectors, uint32_t start_sector, void *buf)
381 ptr_8 = (uint8_t*)buf;
382 ptr_16 = (uint16_t*)buf;
384 while (nr_sectors--) {
385 error = cf_send_cmd(lba, CMD_WRITE_SECTOR);
387 printf("%s: cf_send_cmd(CMD_WRITE_SECTOR) failed: %d\n", __func__, error);
394 for (count = 0; count < SECTOR_SIZE; count++) {
395 cf_outb_8(TF_DATA, *ptr_8++);
396 if ((count & 0xf) == 0)
397 (void)cf_inb_8(TF_STATUS);
403 for (count = 0; count < SECTOR_SIZE; count+=2) {
404 uint16_t temp = *ptr_16++;
405 cf_outw_16(TF_DATA, SWAP_SHORT(temp));
406 if ((count & 0xf) == 0)
407 (void)cf_inb_16(TF_STATUS);
417 /* ------------------------------------------------------------------- *
418 * cf_cmd_identify() *
419 * ------------------------------------------------------------------- *
421 * Read parameters and other information from the drive and store
422 * it in the drive_param structure
425 static int cf_cmd_identify(struct cf_priv *cf_priv)
430 error = cf_send_cmd(0, CMD_IDENTIFY);
432 printf("%s: identify failed: %d\n", __func__, error);
438 for (count = 0; count < SECTOR_SIZE; count++)
439 cf_priv->drive_param.u.buf[count] = cf_inb_8(TF_DATA);
444 for (count = 0; count < SECTOR_SIZE; count += 2) {
446 temp = cf_inw_16(TF_DATA);
448 /* endianess will be swapped below */
449 cf_priv->drive_param.u.buf[count] = (temp & 0xff);
450 cf_priv->drive_param.u.buf[count + 1] = (temp & 0xff00) >> 8;
455 cf_swap_ascii(cf_priv->drive_param.u.driveid.model, cf_priv->drive_param.model);
457 cf_priv->drive_param.sector_size = 512; //= SWAP_SHORT (cf_priv->drive_param.u.driveid.sector_bytes);
458 cf_priv->drive_param.heads = SWAP_SHORT (cf_priv->drive_param.u.driveid.current_heads);
459 cf_priv->drive_param.tracks = SWAP_SHORT (cf_priv->drive_param.u.driveid.current_cylinders);
460 cf_priv->drive_param.sec_track = SWAP_SHORT (cf_priv->drive_param.u.driveid.current_sectors);
461 cf_priv->drive_param.nr_sectors = (uint32_t)SWAP_SHORT (cf_priv->drive_param.u.driveid.lba_size_1) |
462 ((uint32_t)SWAP_SHORT (cf_priv->drive_param.u.driveid.lba_size_2));
464 printf(" model %s\n", cf_priv->drive_param.model);
465 printf(" heads %d tracks %d sec_tracks %d sectors %d\n",
466 cf_priv->drive_param.heads, cf_priv->drive_param.tracks,
467 cf_priv->drive_param.sec_track, cf_priv->drive_param.nr_sectors);
473 /* ------------------------------------------------------------------- *
475 * ------------------------------------------------------------------- *
477 * Send command to read/write one sector specified by lba.
480 static int cf_send_cmd (uint32_t lba, uint8_t cmd)
486 while (cf_inb_8(TF_STATUS) & STATUS_BSY)
488 cf_outb_8(TF_SECTOR_COUNT, 1);
489 cf_outb_8(TF_SECTOR_NUMBER, lba & 0xff);
490 cf_outb_8(TF_CYL_LSB, (lba >> 8) & 0xff);
491 cf_outb_8(TF_CYL_MSB, (lba >> 16) & 0xff);
492 cf_outb_8(TF_DRV_HEAD, ((lba >> 24) & 0xff) | 0xe0);
493 cf_outb_8(TF_COMMAND, cmd);
497 while (cf_inb_16(TF_STATUS) & STATUS_BSY)
499 cf_outw_16(TF_SECTOR_COUNT, 1 | ((lba & 0xff) << 8));
500 cf_outw_16(TF_CYL_LSB, ((lba >> 8) & 0xff) | (((lba >> 16) & 0xff) << 8));
501 cf_outw_16(TF_DRV_HEAD, (((lba >> 24) & 0xff) | 0xe0) | (cmd << 8));
505 return (cf_wait_busy());
508 /* ------------------------------------------------------------------- *
510 * ------------------------------------------------------------------- *
512 * Wait until the drive finishes a given command and data is
513 * ready to be transferred. This is done by repeatedly checking
514 * the BSY bit of the status register. When the controller is ready for
515 * data transfer, it clears the BSY bit and sets the DRQ bit.
517 * If the DF bit is ever set, we return error.
519 * This code originally spun on DRQ. If that behavior turns out to be
520 * necessary, a flag can be added or this function can be called
521 * repeatedly as long as it is returning ENXIO.
523 static int cf_wait_busy (void)
531 status = cf_inb_8(TF_STATUS);
532 while ((status & STATUS_BSY) == STATUS_BSY) {
533 if ((status & STATUS_DF) != 0) {
534 printf("%s: device fault (status=%x)\n", __func__, status);
538 status = cf_inb_8(TF_STATUS);
543 status = cf_inb_16(TF_STATUS);
544 while ((status & STATUS_BSY) == STATUS_BSY) {
545 if ((status & STATUS_DF) != 0) {
546 printf("%s: device fault (status=%x)\n", __func__, status);
550 status = cf_inb_16(TF_STATUS);
555 /* DRQ is only for when read data is actually available; check BSY */
556 /* Some vendors do assert DRQ, but not all. Check BSY instead. */
557 if (status & STATUS_BSY) {
558 printf("%s: device not ready (status=%x)\n", __func__, status);
565 /* ------------------------------------------------------------------- *
567 * ------------------------------------------------------------------- *
569 * The ascii string returned by the controller specifying
570 * the model of the drive is byte-swaped. This routine
571 * corrects the byte ordering.
574 static void cf_swap_ascii (unsigned char str1[], char str2[])
578 for(i = 0; i < MODEL_STR_SIZE; i++)
579 str2[i] = str1[i ^ 1];
582 /* ------------------------------------------------------------------- *
584 * ------------------------------------------------------------------- */
586 static int cf_probe (device_t dev)
588 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_SIM)
591 if (device_get_unit(dev) != 0) {
592 panic("can't attach more devices\n");
595 device_set_desc(dev, "Octeon Compact Flash Driver");
597 return (BUS_PROBE_NOWILDCARD);
600 /* ------------------------------------------------------------------- *
602 * ------------------------------------------------------------------- *
604 * Find the bootbus region for the CF to determine
605 * 16 or 8 bit and check to see if device is
609 static void cf_identify (driver_t *drv, device_t parent)
613 cvmx_mio_boot_reg_cfgx_t cfg;
616 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_SIM)
619 phys_base = cvmx_sysinfo_get()->compact_flash_common_base_addr;
622 base_addr = cvmx_phys_to_ptr(phys_base);
624 for (bus_region = 0; bus_region < 8; bus_region++)
626 cfg.u64 = cvmx_read_csr(CVMX_MIO_BOOT_REG_CFGX(bus_region));
627 if (cfg.s.base == phys_base >> 16)
629 if (cvmx_sysinfo_get()->compact_flash_attribute_base_addr == 0)
630 bus_type = CF_TRUE_IDE_8;
632 bus_type = (cfg.s.width) ? CF_16 : CF_8;
633 printf("Compact flash found in bootbus region %d (%s).\n", bus_region, cf_type[bus_type]);
642 /* Check if CF is inserted */
643 while (cf_inb_8(TF_STATUS) & STATUS_BSY) {
644 if ((count++) == NR_TRIES ) {
645 printf("Compact Flash not present\n");
653 /* Check if CF is inserted */
654 while (cf_inb_16(TF_STATUS) & STATUS_BSY) {
655 if ((count++) == NR_TRIES ) {
656 printf("Compact Flash not present\n");
664 BUS_ADD_CHILD(parent, 0, "cf", 0);
667 /* ------------------------------------------------------------------- *
669 * ------------------------------------------------------------------- */
671 static void cf_attach_geom (void *arg, int flag)
673 struct cf_priv *cf_priv;
675 cf_priv = (struct cf_priv *) arg;
676 cf_priv->cf_geom = g_new_geomf(&g_cf_class, "cf%d", device_get_unit(cf_priv->dev));
677 cf_priv->cf_geom->softc = cf_priv;
678 cf_priv->cf_provider = g_new_providerf(cf_priv->cf_geom, "%s",
679 cf_priv->cf_geom->name);
680 cf_priv->cf_provider->sectorsize = cf_priv->drive_param.sector_size;
681 cf_priv->cf_provider->mediasize = cf_priv->drive_param.nr_sectors * cf_priv->cf_provider->sectorsize;
682 g_error_provider(cf_priv->cf_provider, 0);
685 /* ------------------------------------------------------------------- *
687 * ------------------------------------------------------------------- */
689 static int cf_attach (device_t dev)
691 struct cf_priv *cf_priv;
694 if (cvmx_sysinfo_get()->board_type == CVMX_BOARD_TYPE_SIM)
697 cf_priv = device_get_softc(dev);
700 error = cf_cmd_identify(cf_priv);
702 device_printf(dev, "cf_cmd_identify failed: %d\n", error);
706 g_post_event(cf_attach_geom, cf_priv, M_WAITOK, NULL);
707 bioq_init(&cf_priv->cf_bq);
712 static device_method_t cf_methods[] = {
713 /* Device interface */
714 DEVMETHOD(device_probe, cf_probe),
715 DEVMETHOD(device_identify, cf_identify),
716 DEVMETHOD(device_attach, cf_attach),
717 DEVMETHOD(device_detach, bus_generic_detach),
718 DEVMETHOD(device_shutdown, bus_generic_shutdown),
722 static driver_t cf_driver = {
725 sizeof(struct cf_priv)
728 static devclass_t cf_devclass;
730 DRIVER_MODULE(cf, nexus, cf_driver, cf_devclass, 0, 0);