xref: /netbsd-src/sys/arch/emips/ebus/flash_ebus.c (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: flash_ebus.c,v 1.22 2019/12/14 02:58:19 tsutsui Exp $	*/
2 
3 /*-
4  * Copyright (c) 2010 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code was written by Alessandro Forin and Neil Pittman
8  * at Microsoft Research and contributed to The NetBSD Foundation
9  * by Microsoft Corporation.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #include <sys/cdefs.h>			/* RCS ID & Copyright macro defns */
34 __KERNEL_RCSID(0, "$NetBSD: flash_ebus.c,v 1.22 2019/12/14 02:58:19 tsutsui Exp $");
35 
36 /* Driver for the Intel 28F320/640/128 (J3A150) StrataFlash memory device
37  * Extended to include the Intel JS28F256P30T95.
38  */
39 
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/proc.h>
44 #include <sys/errno.h>
45 #include <sys/ioctl.h>
46 #include <sys/device.h>
47 #include <sys/conf.h>
48 #include <sys/file.h>
49 #include <sys/stat.h>
50 #include <sys/ioctl.h>
51 #include <sys/buf.h>
52 #include <sys/bufq.h>
53 #include <sys/uio.h>
54 #include <sys/malloc.h>
55 #include <uvm/uvm_extern.h>
56 #include <sys/disklabel.h>
57 #include <sys/disk.h>
58 #include <sys/syslog.h>
59 #include <sys/vnode.h>
60 #include <sys/kthread.h>
61 #include <sys/lock.h>
62 #include <sys/queue.h>
63 
64 #include <sys/rndsource.h>
65 
66 #include "locators.h"
67 #include <prop/proplib.h>
68 
69 #include <emips/ebus/ebusvar.h>
70 #include <emips/emips/machdep.h>
71 #include <machine/emipsreg.h>
72 
73 /* Internal config switches
74  */
75 #define USE_BUFFERED_WRITES 0    /* Faster, but might not work in some (older) cases */
76 #define Verbose 0
77 
78 /* Debug tools
79  */
80 #define DEBUG_INTR   0x01
81 #define DEBUG_XFERS  0x02
82 #define DEBUG_STATUS 0x04
83 #define DEBUG_FUNCS  0x08
84 #define DEBUG_PROBE  0x10
85 #define DEBUG_WRITES 0x20
86 #define DEBUG_READS  0x40
87 #define DEBUG_ERRORS 0x80
88 #ifdef DEBUG
89 int eflash_debug = DEBUG_ERRORS;
90 #define EFLASH_DEBUG(x) (eflash_debug & (x))
91 #define DBGME(_lev_,_x_) if ((_lev_) & eflash_debug) _x_
92 #else
93 #define EFLASH_DEBUG(x) (0)
94 #define DBGME(_lev_,_x_)
95 #endif
96 #define DEBUG_PRINT(_args_,_lev_) DBGME(_lev_,printf _args_)
97 
98 /* Product ID codes
99  */
100 #define MANUF_INTEL  0x89
101 #define DEVICE_320   0x16
102 #define DEVICE_640   0x17
103 #define DEVICE_128   0x18
104 #define DEVICE_256   0x19
105 
106 /* Table of chips we understand.
107  */
108 #define nDELTAS 3
109 struct flash_type {
110     struct {
111         uint32_t nSectors;
112         uint32_t nKB;
113     } ft_deltas[nDELTAS];
114     uint8_t ft_manuf_code;
115     uint8_t ft_device_code;
116     uint16_t ft_total_sectors;
117     const char *ft_name;
118 };
119 
120 static const struct flash_type sector_maps[] = {
121     {
122      {{32,128},{0,0},},
123      MANUF_INTEL, DEVICE_320, 32,   /* a J3 part */
124      "StrataFlash 28F320"
125     },
126     {
127      {{64,128},{0,0},},
128      MANUF_INTEL, DEVICE_640, 64,   /* a J3 part */
129      "StrataFlash 28F640"
130     },
131     {
132      {{128,128},{0,0},},
133      MANUF_INTEL, DEVICE_128, 128,   /* a J3 part */
134      "StrataFlash 28F128"
135     },
136     {
137      {{255,128},{4,32},{0,0}},
138      MANUF_INTEL, DEVICE_256, 259,  /* a P30 part */
139 	 "StrataFlash 28F256"
140     }
141 };
142 #define nMAPS ((sizeof sector_maps) / (sizeof sector_maps[0]))
143 
144 /* Instead of dragging in atavar.h.. */
145 struct eflash_bio {
146 	volatile int flags;/* cmd flags */
147 #define	ATA_POLL	0x0002	/* poll for completion */
148 #define	ATA_SINGLE	0x0008	/* transfer must be done in singlesector mode */
149 #define	ATA_READ	0x0020	/* transfer is a read (otherwise a write) */
150 #define	ATA_CORR	0x0040	/* transfer had a corrected error */
151 	daddr_t		blkno;	/* block addr */
152 	daddr_t		blkdone;/* number of blks transferred */
153 	size_t		nblks;	/* number of blocks currently transferring */
154 	size_t	    nbytes;	/* number of bytes currently transferring */
155 	char		*databuf;/* data buffer address */
156 	volatile int	error;
157 	u_int32_t	r_error;/* copy of status register */
158 #ifdef HAS_BAD144_HANDLING
159 	daddr_t		badsect[127];/* 126 plus trailing -1 marker */
160 #endif
161 };
162 /* End of atavar.h*/
163 
164 /* chip-specific functions
165  */
166 struct flash_ops;
167 
168 /*
169  * Device softc
170  */
171 struct eflash_softc {
172 	device_t sc_dev;
173 
174 	/* General disk infos */
175 	struct disk sc_dk;
176 	struct bufq_state *sc_q;
177 	struct callout sc_restart_ch;
178 
179 	/* IDE disk soft states */
180 	struct buf *sc_bp; /* buf being transfered */
181 	struct buf *active_xfer; /* buf handoff to thread  */
182 	struct eflash_bio sc_bio; /* current transfer */
183 
184     struct proc *ch_thread;
185     int ch_flags;
186 #define ATACH_SHUTDOWN 0x02        /* thread is shutting down */
187 #define ATACH_IRQ_WAIT 0x10        /* thread is waiting for irq */
188 #define ATACH_DISABLED 0x80        /* channel is disabled */
189 #define ATACH_TH_RUN   0x100       /* the kernel thread is working */
190 #define ATACH_TH_RESET 0x200       /* someone ask the thread to reset */
191 
192 	int openings;
193 	int sc_flags;
194 #define	EFLASHF_WLABEL	0x004 /* label is writable */
195 #define	EFLASHF_LABELLING	0x008 /* writing label */
196 #define EFLASHF_LOADED	0x010 /* parameters loaded */
197 #define EFLASHF_WAIT	0x020 /* waiting for resources */
198 #define EFLASHF_KLABEL	0x080 /* retain label after 'full' close */
199 
200 	int retries; /* number of xfer retry */
201 
202 	krndsource_t	rnd_source;
203 
204     /* flash-specific state */
205 	struct _Flash *sc_dp;
206     uint32_t sc_size;
207     uint32_t sc_capacity;
208     paddr_t  sc_base;
209     volatile uint8_t *sc_page0;
210 
211     /* current read-write sector mapping */
212     /*volatile*/ uint8_t *sc_sector;
213     uint32_t sc_sector_size;
214     uint32_t sc_sector_offset;
215 #define NOSECTOR ((uint32_t)(~0))
216     int sc_erased;
217 
218     /* device-specificity */
219     uint32_t sc_buffersize;
220     vsize_t sc_max_secsize;
221     unsigned int sc_chips;
222     const struct flash_ops *sc_ops;
223     struct flash_type sc_type;
224 };
225 
226 static int	eflash_ebus_match (device_t, cfdata_t, void *);
227 static void	eflash_ebus_attach (device_t, device_t, void *);
228 
229 CFATTACH_DECL_NEW(flash_ebus, sizeof (struct eflash_softc),
230     eflash_ebus_match, eflash_ebus_attach, NULL, NULL);
231 
232 /* implementation decls */
233 static int flash_identify(struct eflash_softc*);
234 static int KBinSector(struct flash_type * SecMap, unsigned int SecNo);
235 static uint32_t SectorStart(struct flash_type * SecMap, int SecNo);
236 static unsigned int SectorNumber(struct flash_type * SecMap, uint32_t Offset);
237 static void eflash_thread(void *arg);
238 static int eflash_read_at (struct eflash_softc *sc, daddr_t start_sector, char *buffer,
239                            size_t nblocks, size_t * pSizeRead);
240 static int eflash_write_at(struct eflash_softc *sc, daddr_t start_sector, char *buffer,
241                            size_t nblocks, size_t * pSizeWritten);
242 
243 /* Config functions
244  */
245 static int
246 eflash_ebus_match(device_t parent, cfdata_t match, void *aux)
247 {
248 	struct ebus_attach_args *ia = aux;
249 	struct _Flash *f = (struct _Flash *)ia->ia_vaddr;
250 
251 	if (strcmp("flash", ia->ia_name) != 0)
252 		return (0);
253 	if ((f == NULL) ||
254 	    ((f->BaseAddressAndTag & FLASHBT_TAG) != PMTTAG_FLASH))
255 		return (0);
256 
257 	return (1);
258 }
259 
260 static void
261 eflash_ebus_attach(device_t parent, device_t self, void *aux)
262 {
263 	struct ebus_attach_args *ia =aux;
264 	struct eflash_softc *sc = device_private(self);
265     uint32_t base, ctrl;
266     int error;
267 
268     /* Plan.
269      * - mips_map_physmem() (with uncached) first page
270      * - keep it around since we need status ops
271      * - find what type it is.
272      * - then mips_map_physmem() each sector as needed.
273      */
274 
275 	sc->sc_dev = self;
276 	sc->sc_dp = (struct _Flash*)ia->ia_vaddr;
277     base = sc->sc_dp->BaseAddressAndTag & FLASHBT_BASE;
278     ctrl = sc->sc_dp->Control;
279 
280     sc->sc_size = ctrl & FLASHST_SIZE;
281     sc->sc_capacity = sc->sc_size / DEV_BSIZE;
282     sc->sc_base = base;
283     /* The chip is 16bit, so if we get 32bit there are two */
284     sc->sc_chips = (ctrl & FLASHST_BUS_32) ? 2 : 1;
285 
286     /* Map the first page to see what chip we got */
287     sc->sc_page0 = (volatile uint8_t *) mips_map_physmem(base, PAGE_SIZE);
288 
289     if (flash_identify(sc)) {
290         printf(" base %x: %dMB flash memory (%d x %s)\n", base, sc->sc_size >> 20,
291                sc->sc_chips, sc->sc_type.ft_name);
292     } else {
293         /* BUGBUG If we dont identify it stop the driver! */
294         printf(": unknown manufacturer id %x, device id %x\n",
295                sc->sc_type.ft_manuf_code, sc->sc_type.ft_device_code);
296     }
297 
298     config_pending_incr(self);
299 
300 	error = kthread_create(PRI_NONE, 0, NULL,
301 	    eflash_thread, sc, NULL, "%s", device_xname(sc->sc_dev));
302 	if (error)
303 		aprint_error_dev(sc->sc_dev,
304 		    "unable to create kernel thread: error %d\n", error);
305 }
306 
307 /* Implementation functions
308  */
309 /* Returns the size in KBytes of a given sector,
310  * or -1 for bad arguments.
311  */
312 static int KBinSector(struct flash_type * SecMap, unsigned int SecNo)
313 {
314     int i;
315 
316     for (i = 0; i < nDELTAS; i++) {
317         if (SecNo < SecMap->ft_deltas[i].nSectors)
318             return SecMap->ft_deltas[i].nKB;
319         SecNo -= SecMap->ft_deltas[i].nSectors;
320     }
321 
322     return -1;
323 }
324 
325 #define SectorSize(_map_,_sector_) (1024 * KBinSector(_map_,_sector_))
326 
327 /* Whats the starting offset of sector N
328  */
329 static uint32_t SectorStart(struct flash_type * SecMap, int SecNo)
330 {
331     int i;
332     uint32_t Offset = 0;
333 
334     for (i = 0; i < nDELTAS; i++) {
335         if ((unsigned int)SecNo < SecMap->ft_deltas[i].nSectors)
336             return 1024 * (Offset + (SecMap->ft_deltas[i].nKB * SecNo));
337         SecNo -= SecMap->ft_deltas[i].nSectors;
338         Offset += SecMap->ft_deltas[i].nSectors * SecMap->ft_deltas[i].nKB;
339     }
340 
341     return ~0;
342 }
343 
344 /* What sector number corresponds to a given offset
345  */
346 static unsigned int SectorNumber(struct flash_type * SecMap, uint32_t Offset)
347 {
348     unsigned int i;
349     unsigned int SecNo = 0;
350 
351     Offset /= 1024;
352     for (i = 0; i < nDELTAS; i++) {
353         if (Offset < (unsigned int)
354             ((SecMap->ft_deltas[i].nSectors * SecMap->ft_deltas[i].nKB)))
355             return SecNo + (Offset / SecMap->ft_deltas[i].nKB);
356         SecNo += SecMap->ft_deltas[i].nSectors;
357         Offset -= SecMap->ft_deltas[i].nSectors * SecMap->ft_deltas[i].nKB;
358     }
359 
360     return ~0;
361 }
362 
363 /*
364  * Semi-generic operations
365  */
366 struct flash_ops {
367     void (*write_uint8)    (struct eflash_softc *sc, volatile void *Offset, uint8_t Value);
368     void (*read_uint8)     (struct eflash_softc *sc, volatile void *Offset, uint8_t *Value);
369     void (*write_uint16)   (struct eflash_softc *sc, volatile void *Offset, uint16_t Value);
370     void (*read_uint16)    (struct eflash_softc *sc, volatile void *Offset, uint16_t *Value);
371     void (*write_uint32)   (struct eflash_softc *sc, volatile void *Offset, uint32_t Value);
372     void (*read_uint32)    (struct eflash_softc *sc, volatile void *Offset, uint32_t *Value);
373     int  (*program_word)   (struct eflash_softc *sc, volatile void *Offset, uint16_t *pValues,
374                             int  Verify, int *nWritten);
375     int  (*program_buffer) (struct eflash_softc *sc, volatile void *Offset, uint16_t *pValues,
376                             int  Verify, int *nWritten);
377 };
378 
379 /*
380  * Hardware access proper, single-chip
381  */
382 static void single_write_uint8  (struct eflash_softc *sc,volatile void *Offset,uint8_t Value)
383 {
384     volatile uint8_t * Where = Offset;
385     *Where = Value;
386 }
387 
388 static void single_read_uint8   (struct eflash_softc *sc,volatile void *Offset,uint8_t *Value)
389 {
390     volatile uint8_t * Where = Offset;
391     *Value = *Where;
392 }
393 
394 static void single_write_uint16 (struct eflash_softc *sc,volatile void *Offset,uint16_t Value)
395 {
396     volatile uint16_t * Where = Offset;
397     *Where = Value;
398 }
399 
400 static void single_read_uint16  (struct eflash_softc *sc,volatile void *Offset,uint16_t *Value)
401 {
402     volatile uint16_t * Where = Offset;
403     *Value = *Where;
404 }
405 
406 /* This one should not be used, probably */
407 static void single_write_uint32 (struct eflash_softc *sc,volatile void *Offset,uint32_t Value)
408 {
409 #if 0
410     /* The chip cannot take back-to-back writes */
411     volatile uint32_t * Where = Offset;
412     *Where = Value;
413 #else
414     volatile uint8_t * Where = Offset;
415     uint16_t v0, v1;
416 
417     /* Unfortunately, this is bytesex dependent */
418 #if (BYTE_ORDER == BIG_ENDIAN)
419     v1 = (uint16_t) Value;
420     v0 = (uint16_t) (Value >> 16);
421 #else
422     v0 = (uint16_t) Value;
423     v1 = (uint16_t) (Value >> 16);
424 #endif
425     single_write_uint16(sc,Where,v0);
426     single_write_uint16(sc,Where+2,v1);
427 #endif
428 }
429 
430 static void single_read_uint32  (struct eflash_softc *sc,volatile void *Offset,uint32_t *Value)
431 {
432     /* back-to-back reads must be ok */
433     volatile uint32_t * Where = Offset;
434     *Value = *Where;
435 }
436 
437 /*
438  * Hardware access proper, paired-chips
439  * NB: This set of ops assumes two chips in parallel on a 32bit bus,
440  *     each operation is repeated in parallel to both chips
441  */
442 static void twin_write_uint8  (struct eflash_softc *sc,volatile void *Offset,uint8_t Value)
443 {
444     volatile uint32_t * Where = Offset;
445     uint32_t v = Value | ((uint32_t)Value << 16);
446 
447     v = le32toh(v);
448     *Where = v;
449 }
450 
451 static void twin_read_uint8   (struct eflash_softc *sc,volatile void *Offset,uint8_t *Value)
452 {
453     volatile uint32_t * Where = Offset;
454     uint32_t v;
455     v = *Where;
456     v = le32toh(v);
457     *Value = (uint8_t) v;
458 }
459 
460 /* This one should *not* be used, error-prone */
461 static void twin_write_uint16 (struct eflash_softc *sc,volatile void *Offset,uint16_t Value)
462 {
463     volatile uint16_t * Where = Offset;
464     *Where = Value;
465 }
466 
467 static void twin_read_uint16  (struct eflash_softc *sc,volatile void *Offset,uint16_t *Value)
468 {
469     volatile uint16_t * Where = Offset;
470     *Value = *Where;
471 }
472 
473 static void twin_write_uint32 (struct eflash_softc *sc,volatile void *Offset,uint32_t Value)
474 {
475     volatile uint32_t * Where = Offset;
476     Value = le32toh(Value);
477     *Where = Value;
478 }
479 
480 static void twin_read_uint32  (struct eflash_softc *sc,volatile void *Offset,uint32_t *Value)
481 {
482     volatile uint32_t * Where = Offset;
483     uint32_t v;
484     v = *Where;
485     v = le32toh(v);
486     *Value = v;
487 }
488 
489 /*
490  * Command and status definitions
491  */
492 
493 /* Defines for the STATUS register
494  */
495 #define ST_reserved          0x01
496 #define ST_BLOCK_LOCKED      0x02
497 #define ST_PROGRAM_SUSPENDED 0x04
498 #define ST_LOW_VOLTAGE       0x08
499 #define ST_LOCK_BIT_ERROR    0x10
500 #define ST_ERASE_ERROR       0x20
501 #define ST_ERASE_SUSPENDED   0x40
502 #define ST_READY             0x80
503 #define ST_ERASE_MASK        0xee  /* bits to check after erase command */
504 #define ST_MASK              0xfe  /* ignore reserved */
505 
506 /* Command set (what we use of it)
507  */
508 #define CMD_CONFIRM       0xd0
509 #define CMD_READ_ARRAY    0xff
510 #define CMD_READ_ID       0x90
511 #define CMD_READ_STATUS   0x70
512 #define CMD_CLEAR_STATUS  0x50
513 #define CMD_WRITE_WORD    0x40
514 #define CMD_WRITE_BUFFER  0xe8
515 #define CMD_ERASE_SETUP   0x20
516 #define CMD_ERASE_CONFIRM CMD_CONFIRM
517 #define CMD_SET_PREFIX    0x60  /* set read config, lock bits */
518 #define CMD_LOCK          0x01
519 #define CMD_UNLOCK        CMD_CONFIRM
520 /* What we dont use of it
521  */
522 #define CMD_READ_QUERY    0x98
523 # define BUFFER_BYTES          32
524 #define CMD_ERASE_SUSPEND 0xb0
525 #define CMD_ERASE_RESUME  CMD_CONFIRM
526 #define CMD_CONFIGURATION 0xb8
527 #define CMD_PROTECT       0xc0
528 
529 /* Enter the Product ID mode (Read Identifier Codes)
530  */
531 static void ProductIdEnter(struct eflash_softc *sc)
532 {
533     sc->sc_ops->write_uint8(sc,sc->sc_page0,CMD_READ_ID);
534 }
535 
536 /* Exit the Product ID mode (enter Read Array mode)
537  */
538 static void ProductIdExit(struct eflash_softc *sc)
539 {
540     sc->sc_ops->write_uint8(sc,sc->sc_page0,CMD_READ_ARRAY);
541 }
542 
543 /* Read the status register
544  */
545 static uint8_t ReadStatusRegister(struct eflash_softc *sc)
546 {
547     uint8_t Status;
548 
549     sc->sc_ops->write_uint8(sc,sc->sc_page0,CMD_READ_STATUS);
550     sc->sc_ops->read_uint8(sc,sc->sc_page0,&Status);
551     sc->sc_ops->write_uint8(sc,sc->sc_page0,CMD_READ_ARRAY);
552     return Status;
553 }
554 
555 /* Clear error bits in status
556  */
557 static void ClearStatusRegister(struct eflash_softc *sc)
558 {
559     sc->sc_ops->write_uint8(sc,sc->sc_page0,CMD_CLEAR_STATUS);
560 }
561 
562 #if DEBUG
563 /* Decode status bits
564  */
565 typedef const char *string;
566 
567 static void PrintStatus(uint8_t Status)
568 {
569     /* BUGBUG there's a %b format I think? */
570     string BitNames[8] = {
571         "reserved", "BLOCK_LOCKED",
572         "PROGRAM_SUSPENDED", "LOW_VOLTAGE",
573         "LOCK_BIT_ERROR", "ERASE_ERROR",
574         "ERASE_SUSPENDED", "READY"
575     };
576     int i;
577     int  OneSet = FALSE;
578 
579     printf("[status %x =",Status);
580     for (i = 0; i < 8; i++) {
581         if (Status & (1<<i)) {
582             printf("%c%s",
583                      (OneSet) ? '|' : ' ',
584                      BitNames[i]);
585             OneSet = TRUE;
586         }
587     }
588     printf("]\n");
589 }
590 #else
591 #define PrintStatus(x)
592 #endif
593 
594 /*
595  * The device can lock up under certain conditions.
596  * There is no software workaround [must toggle RP# to GND]
597  * Check if it seems that we are in that state.
598  */
599 static int  IsIrresponsive(struct eflash_softc *sc)
600 {
601     uint8_t Status = ReadStatusRegister(sc);
602 
603     if (Status & ST_READY)
604         return FALSE;
605 
606     if ((Status & ST_MASK) ==
607         (ST_LOCK_BIT_ERROR|ST_ERASE_SUSPENDED|ST_ERASE_ERROR)) {
608         /* yes, looks that way */
609         return TRUE;
610     }
611 
612     /* Something is indeed amiss, but we dont really know for sure */
613     PrintStatus(ReadStatusRegister(sc));
614     ClearStatusRegister(sc);
615     PrintStatus(ReadStatusRegister(sc));
616 
617     if ((Status & ST_MASK) ==
618         (ST_LOCK_BIT_ERROR|ST_ERASE_SUSPENDED|ST_ERASE_ERROR)) {
619         /* yes, looks that way */
620         return TRUE;
621     }
622 
623     return FALSE;
624 }
625 
626 
627 /* Write one 16bit word
628  */
629 static int
630 single_program_word(struct eflash_softc *sc, volatile void *Offset, uint16_t *Values,
631                   int  Verify, int *nWritten)
632 {
633     uint8_t Status;
634     uint16_t i, Data16, Value;
635 
636     *nWritten = 0;
637 
638     Value = Values[0];
639 
640     if (Verify) {
641         sc->sc_ops->read_uint16(sc,Offset,&Data16);
642 #ifdef Verbose
643         if (Verbose) {
644             printf("Location %p was x%x\n",
645                    Offset, Data16);
646         }
647 #endif
648         if (Data16 != 0xffff)
649             printf("Offset %p not ERASED, wont take.\n",Offset);
650     }
651 
652     sc->sc_ops->write_uint8(sc,sc->sc_page0,CMD_WRITE_WORD);
653     sc->sc_ops->write_uint16(sc,Offset,Value);
654 
655     /* Wait until the operation is completed
656      * Specs say it takes between 210 and 630 us
657      * Errata says 360 TYP and Max=TBD (sic)
658      */
659     DELAY(800);
660 
661     for (i = 0; i < 10; i++) {
662         sc->sc_ops->read_uint8(sc,Offset,&Status);
663         if ((Status & ST_READY)) break;
664         DELAY(100);
665     }
666 
667     ProductIdExit(sc);
668 
669     if (Verify) {
670         sc->sc_ops->read_uint16(sc,Offset,&Data16);
671 #ifdef Verbose
672         if (Verbose) {
673             printf("Location %p is now x%x\n",
674                    Offset, Data16);
675         }
676 #endif
677         if ((Data16 != Value)) {
678             PrintStatus(Status);
679             printf(". That didnt work, try again.. [%x != %x]\n",
680                    Data16, Value);
681             ClearStatusRegister(sc);
682             return FALSE;
683         }
684     }
685 
686     *nWritten = 2;
687     return TRUE;
688 }
689 
690 /* Write one buffer, 16bit words at a time
691  */
692 static int
693 single_program_buffer(struct eflash_softc *sc, volatile void *Offset, uint16_t *Values,
694                   int  Verify, int *nWritten)
695 {
696     uint8_t Status;
697     uint16_t i, Data16, Value = 0;
698     volatile uint8_t *Where = Offset;
699 
700     *nWritten = 0;
701     if (sc->sc_buffersize == 0)
702         return FALSE; /* sanity */
703 
704     if (Verify) {
705         for (i = 0; i < sc->sc_buffersize; i+= 2) {
706             sc->sc_ops->read_uint16(sc,Where+i,&Data16);
707 #ifdef Verbose
708             if (Verbose) {
709                 printf("Location %p was x%x\n",
710                        Where+i, Data16);
711             }
712 #endif
713 
714             if (Data16 != 0xffff)
715                 printf("Offset %p not ERASED, wont take.\n",Where+i);
716         }
717     }
718 
719     /* Specs say to retry if necessary */
720     for (i = 0; i < 5; i++) {
721         sc->sc_ops->write_uint8(sc,Offset,CMD_WRITE_BUFFER);
722         DELAY(10);
723         sc->sc_ops->read_uint8(sc,Offset,&Status);
724         if ((Status & ST_READY)) break;
725     }
726     if (0 == (Status & ST_READY)) {
727         printf("FAILED program_buffer at Location %p, Status= x%x\n",
728                  Offset, Status);
729         return FALSE;
730     }
731 
732     /* Say how many words we'll be sending */
733     sc->sc_ops->write_uint8(sc,Offset,(uint8_t)(sc->sc_buffersize/2));
734 
735     /* Send the data */
736     for (i = 0; i < sc->sc_buffersize; i+= 2) {
737         Value = Values[i/2];
738         sc->sc_ops->write_uint16(sc,Where+i,Value);
739         DELAY(10);/*jic*/
740     }
741 
742     /* Write confirmation */
743     sc->sc_ops->write_uint8(sc,Offset,CMD_CONFIRM);
744 
745     /* Wait until the operation is completed
746      * Specs say it takes between 800 and 2400 us
747      * Errata says 1600 TYP and Max=TBD (sic), but fixed in stepping A3 and above.
748      */
749     DELAY(800);
750 
751     for (i = 0; i < 20; i++) {
752         sc->sc_ops->write_uint8(sc,Offset,CMD_READ_STATUS);
753         sc->sc_ops->read_uint8(sc,Offset,&Status);
754         if ((Status & ST_READY)) break;
755         DELAY(200);
756     }
757 
758     ProductIdExit(sc);
759 
760     /* Verify? */
761     if (Verify) {
762         for (i = 0; i < sc->sc_buffersize; i+= 2) {
763             sc->sc_ops->read_uint16(sc,Where+i,&Data16);
764 #ifdef Verbose
765             if (Verbose) {
766                 printf("Location %p is now x%x\n",
767                        Where+i, Data16);
768             }
769 #endif
770             Value = Values[i/2];
771 
772             if ((Data16 != Value)) {
773                 PrintStatus(Status);
774                 printf(". That didnt work, try again.. [%x != %x]\n",
775                        Data16, Value);
776                 ClearStatusRegister(sc);
777                 return FALSE;
778             }
779         }
780     }
781 
782     *nWritten = sc->sc_buffersize;
783     return TRUE;
784 }
785 
786 /* Write one 32bit word
787  */
788 static int
789 twin_program_word(struct eflash_softc *sc, volatile void *Offset, uint16_t *Values,
790                 int  Verify, int *nWritten)
791 {
792     uint8_t Status;
793     uint32_t i, Data32, Value;
794     uint16_t v0, v1;
795 
796     *nWritten = 0;
797 
798     v0 = Values[0];
799     v0 = le16toh(v0);
800     v1 = Values[1];
801     v1 = le16toh(v1);
802     Value = v0 | ((uint32_t)v1 << 16);
803     if (Verify) {
804         sc->sc_ops->read_uint32(sc,Offset,&Data32);
805 #ifdef Verbose
806         if (Verbose) {
807             printf("Location %p was x%x\n",
808                    Offset, Data32);
809         }
810 #endif
811         if (Data32 != 0xffffffff)
812             printf("Offset %p not ERASED, wont take.\n",Offset);
813     }
814 
815     sc->sc_ops->write_uint8(sc,sc->sc_page0,CMD_WRITE_WORD);
816     sc->sc_ops->write_uint32(sc,Offset,Value);
817 
818     /* Wait until the operation is completed
819      * Specs say it takes between 210 and 630 us
820      * Errata says 360 TYP and Max=TBD (sic)
821      */
822     DELAY(400);
823 
824     for (i = 0; i < 10; i++) {
825         sc->sc_ops->read_uint8(sc,Offset,&Status);
826         if ((Status & ST_READY)) break;
827         DELAY(100);
828     }
829 
830     ProductIdExit(sc);
831 
832     if (Verify) {
833         sc->sc_ops->read_uint32(sc,Offset,&Data32);
834 #ifdef Verbose
835         if (Verbose) {
836             printf("Location %p is now x%x\n",
837                    Offset, Data32);
838         }
839 #endif
840         if ((Data32 != Value)) {
841             PrintStatus(Status);
842             printf(". That didnt work, try again.. [%x != %x]\n",
843                    Data32, Value);
844             ClearStatusRegister(sc);
845             return FALSE;
846         }
847     }
848 
849     *nWritten = 4;
850     return TRUE;
851 }
852 
853 /* Write one buffer, 32bit words at a time
854  */
855 static int
856 twin_program_buffer(struct eflash_softc *sc, volatile void *Offset, uint16_t *Values,
857                 int  Verify, int *nWritten)
858 {
859     uint8_t Status;
860     uint32_t i, Data32, Value;
861     uint16_t v0 = 0, v1;
862     volatile uint8_t *Where = Offset;
863 
864     *nWritten = 0;
865     if (sc->sc_buffersize == 0)
866         return FALSE; /* sanity */
867 
868     if (Verify) {
869         for (i = 0; i < sc->sc_buffersize; i+= 4) {
870             sc->sc_ops->read_uint32(sc,Where+i,&Data32);
871 #ifdef Verbose
872             if (Verbose) {
873                 printf("Location %p was x%x\n",
874                        Where+i, Data32);
875             }
876 #endif
877             if (Data32 != 0xffffffff)
878                 printf("Offset %p not ERASED, wont take.\n",Where+i);
879         }
880     }
881 
882     /* Specs say to retry if necessary */
883     for (i = 0; i < 5; i++) {
884         sc->sc_ops->write_uint8(sc,Offset,CMD_WRITE_BUFFER);
885         DELAY(10);
886         sc->sc_ops->read_uint8(sc,Offset,&Status);
887         if ((Status & ST_READY)) break;
888     }
889     if (0 == (Status & ST_READY)) {
890         printf("FAILED program_buffer at Location %p, Status= x%x\n",
891                  Offset, Status);
892         return FALSE;
893     }
894 
895     /* Say how many words we'll be sending */
896     sc->sc_ops->write_uint8(sc,Offset,(uint8_t)(sc->sc_buffersize/4)); /* to each twin! */
897 
898     /* Send the data */
899     for (i = 0; i < sc->sc_buffersize; i+= 4) {
900         v0 = Values[i/2];
901         v0 = le16toh(v0);
902         v1 = Values[1+(i/2)];
903         v1 = le16toh(v1);
904         Value = v0 | ((uint32_t)v1 << 16);
905         sc->sc_ops->write_uint32(sc,Where+i,Value);
906         DELAY(10);/*jic*/
907     }
908 
909     /* Write confirmation */
910     sc->sc_ops->write_uint8(sc,Offset,CMD_CONFIRM);
911 
912     /* Wait until the operation is completed
913      * Specs say it takes between 800 and 2400 us
914      * Errata says 1600 TYP and Max=TBD (sic), but fixed in stepping A3 and above.
915      */
916     DELAY(800);
917 
918     for (i = 0; i < 20; i++) {
919         sc->sc_ops->write_uint8(sc,Offset,CMD_READ_STATUS);
920         sc->sc_ops->read_uint8(sc,Offset,&Status);
921         if ((Status & ST_READY)) break;
922         DELAY(200);
923     }
924 
925     ProductIdExit(sc);
926 
927     /* Verify */
928     if (Verify) {
929         for (i = 0; i < sc->sc_buffersize; i+= 4) {
930             sc->sc_ops->read_uint32(sc,Where+i,&Data32);
931 #ifdef Verbose
932             if (Verbose) {
933                 printf("Location %p is now x%x\n",
934                        Where+i, Data32);
935             }
936 #endif
937             v0 = Values[i/2];
938             v0 = le16toh(v0);
939             v1 = Values[1+(i/2)];
940             v1 = le16toh(v1);
941             Value = v0 | ((uint32_t)v1 << 16);
942 
943             if ((Data32 != Value)) {
944                 PrintStatus(Status);
945                 printf(". That didnt work, try again.. [%x != %x]\n",
946                        Data32, Value);
947                 ClearStatusRegister(sc);
948                 return FALSE;
949             }
950         }
951     }
952 
953     *nWritten = sc->sc_buffersize;
954     return TRUE;
955 }
956 
957 /* Is there a lock on a given sector
958  */
959 static int IsSectorLocked(struct eflash_softc *sc, uint8_t *secptr)
960 {
961     uint8_t Data, Data1;
962 
963     ProductIdEnter(sc);
964     /* Lockout info is at address 2 of the given sector, meaning A0=0 A1=1.
965      */
966     sc->sc_ops->read_uint8(sc,secptr+(0x0002*2*sc->sc_chips),&Data);
967     sc->sc_ops->read_uint8(sc,secptr+(0x0003*2*sc->sc_chips),&Data1);
968 
969     ProductIdExit(sc);
970 
971     return (Data & 1);
972 }
973 
974 /* Remove the write-lock to a sector
975  */
976 static void SectorUnLock(struct eflash_softc *sc, uint8_t *secptr)
977 {
978     uint8_t Status;
979     int i;
980 
981     DBGME(DEBUG_FUNCS,printf("%s: Unlocking sector %d [ptr %p] ...\n",
982 	device_xname(sc->sc_dev), sc->sc_sector_offset, secptr));
983 
984     sc->sc_ops->write_uint8(sc,sc->sc_page0,CMD_SET_PREFIX);
985     sc->sc_ops->write_uint8(sc,secptr,CMD_UNLOCK);
986 
987     /* Wait until the unlock is complete.
988      * Specs say this takes between 64 and 75 usecs.
989      */
990     DELAY(100);
991 
992     for (i = 0; i < 10; i++) {
993         sc->sc_ops->read_uint8(sc,secptr,&Status);
994         if ((Status & ST_READY)) break;
995         DELAY(100);
996     }
997 
998     ProductIdExit(sc);
999 
1000     if ((Status & ST_MASK) == ST_READY) {
1001         DBGME(DEBUG_FUNCS,printf("%s: Unlocked ok.\n",
1002 	    device_xname(sc->sc_dev)));
1003         return;
1004     }
1005 
1006     PrintStatus(Status);
1007     DBGME(DEBUG_ERRORS,printf("%s: Unlock of sector %d NOT completed (status=%x).\n",
1008                               device_xname(sc->sc_dev),
1009 			      sc->sc_sector_offset, Status));
1010     ClearStatusRegister(sc);
1011 }
1012 
1013 
1014 /* Erase one sector
1015  */
1016 static int  SectorErase(struct eflash_softc *sc, void *secptr)
1017 {
1018     uint8_t Status = 0;
1019     uint16_t i;
1020 
1021     DBGME(DEBUG_FUNCS,printf("%s: Erasing sector %d [ptr %p] ...\n",
1022 	device_xname(sc->sc_dev), sc->sc_sector_offset, secptr));
1023 
1024     /* On some chips we just cannot avoid the locking business.
1025      */
1026     if ((sc->sc_chips == 1) &&
1027         IsSectorLocked(sc,secptr))
1028         SectorUnLock(sc,secptr);
1029 
1030     sc->sc_ops->write_uint8(sc,secptr,CMD_ERASE_SETUP);
1031     sc->sc_ops->write_uint8(sc,secptr,CMD_ERASE_CONFIRM);
1032 
1033     /* Wait until the erase is actually completed
1034      * Specs say it will take between 1 and 5 seconds.
1035      * Errata says it takes 2 sec min and 25 sec max.
1036      * Double that before giving up.
1037      */
1038     for (i = 0; i < 20; i++) {
1039         /* Sleep for at least 2 seconds
1040          */
1041         tsleep(sc,PWAIT,"erase", hz * 2);
1042 
1043         sc->sc_ops->read_uint8(sc,secptr,&Status);
1044         if ((Status & ST_READY)) break;
1045         PrintStatus(Status);
1046     }
1047 
1048     ProductIdExit(sc);
1049 
1050     if ((Status & ST_ERASE_MASK) == ST_READY) {
1051         DBGME(DEBUG_FUNCS,printf("%s: Erased ok.\n", device_xname(sc->sc_dev)));
1052         return 0;
1053     }
1054 
1055     PrintStatus(Status);
1056     DBGME(DEBUG_ERRORS,printf("%s: Erase of sector %d NOT completed (status=%x).\n",
1057                               device_xname(sc->sc_dev),
1058 			      sc->sc_sector_offset, Status));
1059 
1060     ClearStatusRegister(sc);
1061     return EIO;
1062 }
1063 
1064 
1065 
1066 /* Write (a portion of) a sector
1067  */
1068 static size_t eflash_write_sector(struct eflash_softc *sc, char *Buffer, size_t n,
1069                                uint8_t *Offset, int Verify)
1070 {
1071     size_t i;
1072 
1073     /* Make sure the device is not screwed up
1074      */
1075     if (IsIrresponsive(sc)) {
1076         printf("FLASH is locked-up (or mapped cacheable?), wont work. ");
1077     }
1078 
1079     for (i = 0; i < n;) {
1080         int nTries;
1081         int nWritten = 0;/*we expect 2 or 4 */
1082 
1083         if (sc->sc_buffersize && ((n-i) >= sc->sc_buffersize)) {
1084             for (nTries = 0; nTries < 5; nTries++)
1085                 if (sc->sc_ops->program_buffer(sc,Offset,(uint16_t*)(Buffer+i),Verify,&nWritten))
1086                     break;
1087         } else {
1088             for (nTries = 0; nTries < 5; nTries++)
1089                 if (sc->sc_ops->program_word(sc,Offset,(uint16_t*)(Buffer+i),Verify,&nWritten))
1090                     break;
1091         }
1092         Offset += nWritten;
1093         i += nWritten;
1094         if (nWritten == 0)
1095             break;
1096     }
1097     return i;
1098 }
1099 
1100 /* Identify type and the sector map of the FLASH.
1101  * Argument is the base address of the device and the count of chips on the bus (1/2)
1102  * Returns FALSE if failed
1103  */
1104 static const struct flash_ops single_ops = {
1105     single_write_uint8,
1106     single_read_uint8,
1107     single_write_uint16,
1108     single_read_uint16,
1109     single_write_uint32,
1110     single_read_uint32,
1111     single_program_word,
1112     single_program_buffer
1113 };
1114 
1115 static const struct flash_ops twin_ops = {
1116     twin_write_uint8,
1117     twin_read_uint8,
1118     twin_write_uint16,
1119     twin_read_uint16,
1120     twin_write_uint32,
1121     twin_read_uint32,
1122     twin_program_word,
1123     twin_program_buffer
1124 };
1125 
1126 static int  flash_identify(struct eflash_softc *sc)
1127 {
1128     uint8_t Mid, Did;
1129     int i;
1130 
1131     if (sc->sc_chips > 1)
1132         sc->sc_ops = &twin_ops;
1133     else
1134         sc->sc_ops = &single_ops;
1135 
1136     sc->sc_buffersize = 0;
1137 #if USE_BUFFERED_WRITES
1138     sc->sc_buffersize = BUFFER_BYTES * sc->sc_chips;
1139 #endif
1140     sc->sc_sector = NULL;
1141     sc->sc_sector_size = 0;
1142     sc->sc_sector_offset = NOSECTOR;
1143     sc->sc_erased = FALSE;
1144 
1145     ProductIdEnter(sc);
1146     sc->sc_ops->read_uint8(sc,sc->sc_page0+(0x0000*2*sc->sc_chips),&Mid);
1147     sc->sc_ops->read_uint8(sc,sc->sc_page0+(0x0001*2*sc->sc_chips),&Did);
1148     ProductIdExit(sc);
1149 
1150     sc->sc_type.ft_manuf_code = Mid;
1151     sc->sc_type.ft_device_code = Did;
1152 
1153     for (i = 0; i < nMAPS; i++) {
1154         if ((sector_maps[i].ft_manuf_code == Mid) && (sector_maps[i].ft_device_code == Did)) {
1155             int j;
1156             uint32_t ms = 0;
1157             sc->sc_type = sector_maps[i];
1158             /* double the sector sizes if twin-chips */
1159             for (j = 0; j < nDELTAS; j++) {
1160                 sc->sc_type.ft_deltas[j].nKB *= sc->sc_chips;
1161                 if (ms < sc->sc_type.ft_deltas[j].nKB)
1162                     ms = sc->sc_type.ft_deltas[j].nKB;
1163             }
1164             sc->sc_max_secsize = ms * 1024;
1165             return TRUE;
1166         }
1167     }
1168 
1169     return FALSE;
1170 }
1171 
1172 /* Common code for read&write argument validation
1173  */
1174 static int eflash_validate(struct eflash_softc *sc, daddr_t start, size_t *pSize, void **pSrc)
1175 {
1176     daddr_t Size;
1177     uint32_t sec;
1178     size_t secsize, secstart;
1179 
1180     /* Validate args
1181      */
1182     if (start >= sc->sc_capacity) {
1183         *pSize = 0;
1184         DBGME(DEBUG_ERRORS,printf("eflash::ValidateArg(%qx) EOF\n", start));
1185         return E2BIG;
1186     }
1187 
1188     /* Map sector if not already
1189      */
1190     sec = SectorNumber(&sc->sc_type, start << DEV_BSHIFT);
1191     secsize = SectorSize( &sc->sc_type, sec);
1192     secstart = SectorStart(&sc->sc_type,sec);
1193     if (sec != sc->sc_sector_offset) {
1194         int error;
1195 
1196         /* unmap previous first */
1197         if (sc->sc_sector_offset != NOSECTOR) {
1198             DBGME(DEBUG_FUNCS,printf("%s: unmap %p %zx\n",
1199 		device_xname(sc->sc_dev), sc->sc_sector, sc->sc_sector_size));
1200             iounaccess((vaddr_t)sc->sc_sector, sc->sc_sector_size);
1201             sc->sc_sector_offset = NOSECTOR;
1202         }
1203 
1204         /* map new */
1205         error = ioaccess((vaddr_t)sc->sc_sector,
1206                          secstart + sc->sc_base,
1207                          secsize);
1208         DBGME(DEBUG_FUNCS,printf("%s: mapped %p %zx -> %zx %d\n",
1209 	    device_xname(sc->sc_dev),
1210 	    sc->sc_sector, secsize, secstart + sc->sc_base,error));
1211         if (error) return error;
1212 
1213         /* Update state. We have to assume the sector was not erased. Sigh. */
1214         sc->sc_sector_offset = sec;
1215         sc->sc_sector_size = secsize;
1216         sc->sc_erased = FALSE;
1217     }
1218 
1219     /* Adjust size if necessary
1220      */
1221     Size = start + *pSize; /* last sector */
1222     if (Size > sc->sc_capacity) {
1223         /* At most this many sectors
1224          */
1225         Size = sc->sc_capacity - start;
1226         *pSize = (size_t)Size;
1227     }
1228     if (*pSize > (secsize >> DEV_BSHIFT)) {
1229         *pSize = secsize >> DEV_BSHIFT;
1230     }
1231 
1232     *pSrc = sc->sc_sector + (start << DEV_BSHIFT) - secstart;
1233 
1234     DBGME(DEBUG_FUNCS,printf("%s: Validate %qx %zd %p\n",
1235 	device_xname(sc->sc_dev), start,*pSize, *pSrc));
1236     return 0;
1237 }
1238 
1239 static int eflash_read_at (struct eflash_softc *sc,
1240                            daddr_t start_sector, char *buffer, size_t nblocks,
1241                            size_t * pSizeRead)
1242 {
1243     int error;
1244     uint32_t SizeRead = 0;
1245     void *src;
1246 
1247     DBGME(DEBUG_XFERS|DEBUG_READS,printf("%s: EflashReadAt(%qx %p %zd %p)\n",
1248                      device_xname(sc->sc_dev), start_sector, buffer, nblocks, pSizeRead));
1249 
1250     /* Validate & trim arguments
1251      */
1252     error = eflash_validate(sc, start_sector, &nblocks, &src);
1253 
1254     /* Copy data if
1255      */
1256     if (error == 0) {
1257         SizeRead = nblocks;
1258         memcpy(buffer, src, nblocks << DEV_BSHIFT);
1259     }
1260 
1261     if (pSizeRead)
1262         *pSizeRead = SizeRead;
1263     return error;
1264 }
1265 
1266 /* Write SIZE bytes to device.
1267  */
1268 static int eflash_write_at (struct eflash_softc *sc,
1269                            daddr_t start_sector, char *buffer, size_t nblocks,
1270                            size_t * pSizeWritten)
1271 {
1272     int error;
1273     void *src;
1274     size_t SizeWritten = 0;
1275 
1276     DBGME(DEBUG_XFERS|DEBUG_WRITES,printf("%s: EflashWriteAt(%qx %p %zd %p)\n",
1277                      device_xname(sc->sc_dev), start_sector, buffer, nblocks, pSizeWritten));
1278 
1279     /* Validate & trim arguments
1280      */
1281     error = eflash_validate(sc, start_sector, &nblocks, &src);
1282 
1283     if (error == 0) {
1284         /* Do we have to erase it */
1285         if (! sc->sc_erased) {
1286 
1287             error = SectorErase(sc,src);
1288             if (error)
1289                 goto Out;
1290             sc->sc_erased = TRUE;
1291         }
1292         SizeWritten = eflash_write_sector(sc, buffer, nblocks << DEV_BSHIFT, src, TRUE);
1293         SizeWritten >>= DEV_BSHIFT;
1294     }
1295 
1296  Out:
1297     if (pSizeWritten)
1298         *pSizeWritten = SizeWritten;
1299     return error;
1300 }
1301 
1302 /* Rest of code lifted with mods from the dev\ata\wd.c driver
1303  */
1304 
1305 /*
1306  * Copyright (c) 1998, 2001 Manuel Bouyer.  All rights reserved.
1307  *
1308  * Redistribution and use in source and binary forms, with or without
1309  * modification, are permitted provided that the following conditions
1310  * are met:
1311  * 1. Redistributions of source code must retain the above copyright
1312  *	notice, this list of conditions and the following disclaimer.
1313  * 2. Redistributions in binary form must reproduce the above copyright
1314  *	notice, this list of conditions and the following disclaimer in the
1315  *	documentation and/or other materials provided with the distribution.
1316  *
1317  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1318  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
1319  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1320  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
1321  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
1322  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
1323  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
1324  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
1325  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
1326  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1327  */
1328 
1329 /*-
1330  * Copyright (c) 1998, 2003, 2004 The NetBSD Foundation, Inc.
1331  * All rights reserved.
1332  *
1333  * This code is derived from software contributed to The NetBSD Foundation
1334  * by Charles M. Hannum and by Onno van der Linden.
1335  *
1336  * Redistribution and use in source and binary forms, with or without
1337  * modification, are permitted provided that the following conditions
1338  * are met:
1339  * 1. Redistributions of source code must retain the above copyright
1340  *    notice, this list of conditions and the following disclaimer.
1341  * 2. Redistributions in binary form must reproduce the above copyright
1342  *    notice, this list of conditions and the following disclaimer in the
1343  *    documentation and/or other materials provided with the distribution.
1344  *
1345  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
1346  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
1347  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
1348  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
1349  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1350  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1351  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1352  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1353  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1354  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1355  * POSSIBILITY OF SUCH DAMAGE.
1356  */
1357 
1358 static const char ST506[] = "ST506";
1359 
1360 #define	EFLASHIORETRIES_SINGLE 4	/* number of retries before single-sector */
1361 #define	EFLASHIORETRIES	5	/* number of retries before giving up */
1362 #define	RECOVERYTIME hz/2	/* time to wait before retrying a cmd */
1363 
1364 #define	EFLASHUNIT(dev)		DISKUNIT(dev)
1365 #define	EFLASHPART(dev)		DISKPART(dev)
1366 #define	EFLASHMINOR(unit, part)	DISKMINOR(unit, part)
1367 #define	MAKEEFLASHDEV(maj, unit, part)	MAKEDISKDEV(maj, unit, part)
1368 
1369 #define	EFLASHLABELDEV(dev)	(MAKEEFLASHDEV(major(dev), EFLASHUNIT(dev), RAW_PART))
1370 
1371 void	eflashperror(const struct eflash_softc *);
1372 
1373 extern struct cfdriver eflash_cd;
1374 
1375 dev_type_open(eflashopen);
1376 dev_type_close(eflashclose);
1377 dev_type_read(eflashread);
1378 dev_type_write(eflashwrite);
1379 dev_type_ioctl(eflashioctl);
1380 dev_type_strategy(eflashstrategy);
1381 dev_type_dump(eflashdump);
1382 dev_type_size(eflashsize);
1383 
1384 const struct bdevsw eflash_bdevsw = {
1385 	.d_open = eflashopen,
1386 	.d_close = eflashclose,
1387 	.d_strategy = eflashstrategy,
1388 	.d_ioctl = eflashioctl,
1389 	.d_dump = eflashdump,
1390 	.d_psize = eflashsize,
1391 	.d_discard = nodiscard,
1392 	.d_flag = D_DISK
1393 };
1394 
1395 const struct cdevsw eflash_cdevsw = {
1396 	.d_open = eflashopen,
1397 	.d_close = eflashclose,
1398 	.d_read = eflashread,
1399 	.d_write = eflashwrite,
1400 	.d_ioctl = eflashioctl,
1401 	.d_stop = nostop,
1402 	.d_tty = notty,
1403 	.d_poll = nopoll,
1404 	.d_mmap = nommap,
1405 	.d_kqfilter = nokqfilter,
1406 	.d_discard = nodiscard,
1407 	.d_flag = D_DISK
1408 };
1409 
1410 void  eflashgetdefaultlabel(struct eflash_softc *, struct disklabel *);
1411 void  eflashgetdisklabel(struct eflash_softc *);
1412 void  eflashstart(void *);
1413 void  __eflashstart(struct eflash_softc *, struct buf *);
1414 void  eflashrestart(void *);
1415 void  eflashattach(struct eflash_softc *);
1416 int   eflashdetach(device_t, int);
1417 int   eflashactivate(device_t, enum devact);
1418 
1419 void  eflashdone(struct eflash_softc *);
1420 static void eflash_set_geometry(struct eflash_softc *sc);
1421 
1422 struct dkdriver eflashdkdriver = {
1423 	.d_strategy = eflashstrategy,
1424 	.d_minphys = minphys
1425 };
1426 
1427 #ifdef HAS_BAD144_HANDLING
1428 static void bad144intern(struct eflash_softc *);
1429 #endif
1430 
1431 static void eflash_wedges(void *arg);
1432 
1433 void
1434 eflashattach(struct eflash_softc *sc)
1435 {
1436 	device_t self = sc->sc_dev;
1437 	char pbuf[9];
1438 	DEBUG_PRINT(("%s: eflashattach\n",  device_xname(sc->sc_dev)), DEBUG_FUNCS | DEBUG_PROBE);
1439 
1440 	callout_init(&sc->sc_restart_ch, 0);
1441 	bufq_alloc(&sc->sc_q, BUFQ_DISK_DEFAULT_STRAT, BUFQ_SORT_RAWBLOCK);
1442 
1443     sc->openings = 1; /* wazziz?*/
1444 
1445 	aprint_naive("\n");
1446 
1447     /* setup all required fields so that if the attach fails we are ok */
1448 	sc->sc_dk.dk_driver = &eflashdkdriver;
1449 	sc->sc_dk.dk_name = device_xname(sc->sc_dev);
1450 
1451 	format_bytes(pbuf, sizeof(pbuf), sc->sc_capacity * DEV_BSIZE);
1452 	aprint_normal("%s: %s, %d cyl, %d head, %d sec, %d bytes/sect x %llu sectors\n",
1453 	    device_xname(self), pbuf, 1, 1, sc->sc_capacity,
1454 	    DEV_BSIZE, (unsigned long long)sc->sc_capacity);
1455 
1456     eflash_set_geometry(sc);
1457 
1458 	/*
1459 	 * Attach the disk structure. We fill in dk_info later.
1460 	 */
1461 	disk_attach(&sc->sc_dk);
1462 
1463 	rnd_attach_source(&sc->rnd_source, device_xname(sc->sc_dev),
1464 			  RND_TYPE_DISK, RND_FLAG_DEFAULT);
1465 
1466 }
1467 
1468 int
1469 eflashactivate(device_t self, enum devact act)
1470 {
1471 	int rv = 0;
1472 
1473 	DEBUG_PRINT(("eflashactivate %x\n",  act), DEBUG_FUNCS | DEBUG_PROBE);
1474 
1475 	switch (act) {
1476 	case DVACT_DEACTIVATE:
1477 		/*
1478 		 * Nothing to do; we key off the device's DVF_ACTIVATE.
1479 		 */
1480 		break;
1481 	default:
1482 		rv = EOPNOTSUPP;
1483 		break;
1484 	}
1485 	return (rv);
1486 }
1487 
1488 int
1489 eflashdetach(device_t self, int flags)
1490 {
1491 	struct eflash_softc *sc = device_private(self);
1492 	int s, bmaj, cmaj, i, mn;
1493 
1494 	DEBUG_PRINT(("%s: eflashdetach\n",  device_xname(sc->sc_dev)), DEBUG_FUNCS | DEBUG_PROBE);
1495 
1496 	/* locate the major number */
1497 	bmaj = bdevsw_lookup_major(&eflash_bdevsw);
1498 	cmaj = cdevsw_lookup_major(&eflash_cdevsw);
1499 
1500 	/* Nuke the vnodes for any open instances. */
1501 	for (i = 0; i < MAXPARTITIONS; i++) {
1502 		mn = EFLASHMINOR(device_unit(self), i);
1503 		vdevgone(bmaj, mn, mn, VBLK);
1504 		vdevgone(cmaj, mn, mn, VCHR);
1505 	}
1506 
1507 	/* Delete all of our wedges. */
1508 	dkwedge_delall(&sc->sc_dk);
1509 
1510 	s = splbio();
1511 
1512 	/* Kill off any queued buffers. */
1513 	bufq_drain(sc->sc_q);
1514 
1515 	/*sc->atabus->ata_killpending(sc->drvp);*/
1516 
1517 	splx(s);
1518 	bufq_free(sc->sc_q);
1519 
1520 	/* Detach disk. */
1521 	disk_detach(&sc->sc_dk);
1522 
1523 	/* Unhook the entropy source. */
1524 	rnd_detach_source(&sc->rnd_source);
1525 
1526 	/*sc->drvp->drive_flags = 0; -- no drive any more here */
1527 
1528 	return (0);
1529 }
1530 
1531 extern int	dkwedge_autodiscover;
1532 
1533 /* Aux temp thread to avoid deadlock when doing the partitio.. ahem wedges thing.
1534  */
1535 static void
1536 eflash_wedges(void *arg)
1537 {
1538 	struct eflash_softc *sc = (struct eflash_softc*)arg;
1539 
1540     DBGME(DEBUG_STATUS,printf("%s: wedges started for %p\n", sc->sc_dk.dk_name, sc));
1541 
1542 	/* Discover wedges on this disk. */
1543     dkwedge_autodiscover = 1;
1544 	dkwedge_discover(&sc->sc_dk);
1545 
1546     config_pending_decr(sc->sc_dev);
1547 
1548     DBGME(DEBUG_STATUS,printf("%s: wedges thread done for %p\n", device_xname(sc->sc_dev), sc));
1549 	kthread_exit(0);
1550 }
1551 
1552 static void
1553 eflash_thread(void *arg)
1554 {
1555 	struct eflash_softc *sc = (struct eflash_softc*)arg;
1556 	struct buf *bp;
1557     vaddr_t addr;
1558 	int s, error;
1559 
1560     DBGME(DEBUG_STATUS,printf("%s: thread started for %p\n", device_xname(sc->sc_dev), sc));
1561 
1562     s = splbio();
1563     eflashattach(sc);
1564     splx(s);
1565 
1566     /* Allocate a VM window large enough to map the largest sector
1567      * BUGBUG We could risk it and allocate/free on open/close?
1568      */
1569     addr = uvm_km_alloc(kernel_map, sc->sc_max_secsize, 0, UVM_KMF_VAONLY);
1570     if (addr == 0)
1571         panic("eflash_thread: kernel map full (%lx)", (long unsigned)sc->sc_max_secsize);
1572     sc->sc_sector = (/*volatile*/ uint8_t *) addr;
1573     sc->sc_sector_size = 0;
1574     sc->sc_sector_offset = NOSECTOR;
1575 
1576 	error = kthread_create(PRI_NONE, 0, NULL,
1577 	    eflash_wedges, sc, NULL, "%s.wedges", device_xname(sc->sc_dev));
1578 	if (error) {
1579 		aprint_error_dev(sc->sc_dev, "wedges: unable to create kernel "
1580 		    "thread: error %d\n", error);
1581 		/* XXX: why continue? */
1582 	}
1583 
1584 
1585     DBGME(DEBUG_STATUS,printf("%s: thread service active for %p\n", device_xname(sc->sc_dev), sc));
1586 
1587     s = splbio();
1588 	for (;;) {
1589         /* Get next I/O request, wait if necessary
1590          */
1591 		if ((sc->ch_flags & (ATACH_TH_RESET | ATACH_SHUTDOWN)) == 0 &&
1592 		    (sc->active_xfer == NULL)) {
1593 			sc->ch_flags &= ~ATACH_TH_RUN;
1594 			(void) tsleep(&sc->ch_thread, PRIBIO, "eflashth", 0);
1595 			sc->ch_flags |= ATACH_TH_RUN;
1596 		}
1597 		if (sc->ch_flags & ATACH_SHUTDOWN) {
1598 			break;
1599         }
1600         bp = sc->active_xfer;
1601         sc->active_xfer = NULL;
1602 		if (bp != NULL) {
1603 
1604             size_t sz = DEV_BSIZE, bnow;
1605 
1606             DBGME(DEBUG_XFERS,printf("%s: task %p %x %p %qx %d (%zd)\n", device_xname(sc->sc_dev), bp,
1607                                      sc->sc_bio.flags, sc->sc_bio.databuf, sc->sc_bio.blkno,
1608                                      sc->sc_bio.nbytes, sc->sc_bio.nblks));
1609 
1610             sc->sc_bio.error = 0;
1611             for (; sc->sc_bio.nblks > 0;) {
1612 
1613                 bnow = sc->sc_bio.nblks;
1614                 if (sc->sc_bio.flags & ATA_SINGLE) bnow = 1;
1615 
1616                 if (sc->sc_bio.flags & ATA_READ) {
1617                     sc->sc_bio.error =
1618                         eflash_read_at(sc, sc->sc_bio.blkno, sc->sc_bio.databuf, bnow, &sz);
1619                 } else {
1620                     sc->sc_bio.error =
1621                         eflash_write_at(sc, sc->sc_bio.blkno, sc->sc_bio.databuf, bnow, &sz);
1622                 }
1623 
1624                 if (sc->sc_bio.error)
1625                     break;
1626 
1627                 sc->sc_bio.blkno += sz; /* in blocks */
1628                 sc->sc_bio.nblks -= sz;
1629                 sc->sc_bio.blkdone += sz;
1630                 sz = sz << DEV_BSHIFT; /* in bytes */
1631                 sc->sc_bio.databuf += sz;
1632                 sc->sc_bio.nbytes  -= sz;
1633             }
1634 
1635             eflashdone(sc);
1636         }
1637 	}
1638 
1639 	splx(s);
1640 	sc->ch_thread = NULL;
1641 	wakeup(&sc->ch_flags);
1642 
1643     DBGME(DEBUG_STATUS,printf("%s: thread service terminated for %p\n", device_xname(sc->sc_dev), sc));
1644 
1645 	kthread_exit(0);
1646 }
1647 
1648 
1649 /*
1650  * Read/write routine for a buffer.  Validates the arguments and schedules the
1651  * transfer.  Does not wait for the transfer to complete.
1652  */
1653 void
1654 eflashstrategy(struct buf *bp)
1655 {
1656 	struct eflash_softc *sc = device_lookup_private(&eflash_cd, EFLASHUNIT(bp->b_dev));
1657 	struct disklabel *lp = sc->sc_dk.dk_label;
1658 	daddr_t blkno;
1659 	int s;
1660 
1661 	DEBUG_PRINT(("%s: eflashstrategy %lld\n", device_xname(sc->sc_dev), bp->b_blkno),
1662 	    DEBUG_XFERS);
1663 
1664 	/* Valid request?  */
1665 	if (bp->b_blkno < 0 ||
1666 	    (bp->b_bcount % lp->d_secsize) != 0 ||
1667 	    (bp->b_bcount / lp->d_secsize) >= (1 << NBBY)) {
1668 		bp->b_error = EINVAL;
1669 		goto done;
1670 	}
1671 
1672 	/* If device invalidated (e.g. media change, door open), error. */
1673 	if ((sc->sc_flags & EFLASHF_LOADED) == 0) {
1674 		bp->b_error = EIO;
1675 		goto done;
1676 	}
1677 
1678 	/* If it's a null transfer, return immediately. */
1679 	if (bp->b_bcount == 0)
1680 		goto done;
1681 
1682 	/*
1683 	 * Do bounds checking, adjust transfer. if error, process.
1684 	 * If end of partition, just return.
1685 	 */
1686 	if (EFLASHPART(bp->b_dev) == RAW_PART) {
1687 		if (bounds_check_with_mediasize(bp, DEV_BSIZE,
1688 		    sc->sc_capacity) <= 0)
1689 			goto done;
1690 	} else {
1691 		if (bounds_check_with_label(&sc->sc_dk, bp,
1692 		    (sc->sc_flags & (EFLASHF_WLABEL|EFLASHF_LABELLING)) != 0) <= 0)
1693 			goto done;
1694 	}
1695 
1696 	/*
1697 	 * Now convert the block number to absolute and put it in
1698 	 * terms of the device's logical block size.
1699 	 */
1700 	if (lp->d_secsize >= DEV_BSIZE)
1701 		blkno = bp->b_blkno / (lp->d_secsize / DEV_BSIZE);
1702 	else
1703 		blkno = bp->b_blkno * (DEV_BSIZE / lp->d_secsize);
1704 
1705 	if (EFLASHPART(bp->b_dev) != RAW_PART)
1706 		blkno += lp->d_partitions[EFLASHPART(bp->b_dev)].p_offset;
1707 
1708 	bp->b_rawblkno = blkno;
1709 
1710 	/* Queue transfer on drive, activate drive and controller if idle. */
1711 	s = splbio();
1712 	bufq_put(sc->sc_q, bp);
1713 	eflashstart(sc);
1714 	splx(s);
1715 	return;
1716 done:
1717 	/* Toss transfer; we're done early. */
1718 	bp->b_resid = bp->b_bcount;
1719 	biodone(bp);
1720 }
1721 
1722 /*
1723  * Queue a drive for I/O.
1724  */
1725 void
1726 eflashstart(void *arg)
1727 {
1728 	struct eflash_softc *sc = arg;
1729 	struct buf *bp = NULL;
1730 
1731 	DEBUG_PRINT(("%s: eflashstart\n", device_xname(sc->sc_dev)),
1732 	    DEBUG_XFERS);
1733 	while (sc->openings > 0) {
1734 
1735 		/* Is there a buf for us ? */
1736 		if ((bp = bufq_get(sc->sc_q)) == NULL)
1737 			return;
1738 
1739 		/*
1740 		 * Make the command. First lock the device
1741 		 */
1742 		sc->openings--;
1743 
1744 		sc->retries = 0;
1745 		__eflashstart(sc, bp);
1746 	}
1747 }
1748 
1749 void
1750 __eflashstart(struct eflash_softc *sc, struct buf *bp)
1751 {
1752 	DEBUG_PRINT(("%s: __eflashstart %p\n", device_xname(sc->sc_dev), bp),
1753 	    DEBUG_XFERS);
1754 
1755 	sc->sc_bp = bp;
1756 	/*
1757 	 * If we're retrying, retry in single-sector mode. This will give us
1758 	 * the sector number of the problem, and will eventually allow the
1759 	 * transfer to succeed.
1760 	 */
1761 	if (sc->retries >= EFLASHIORETRIES_SINGLE)
1762 		sc->sc_bio.flags = ATA_SINGLE;
1763 	else
1764 		sc->sc_bio.flags = 0;
1765 	if (bp->b_flags & B_READ)
1766 		sc->sc_bio.flags |= ATA_READ;
1767 	sc->sc_bio.blkno = bp->b_rawblkno;
1768 	sc->sc_bio.blkdone = 0;
1769 	sc->sc_bio.nbytes = bp->b_bcount;
1770 	sc->sc_bio.nblks  = bp->b_bcount >> DEV_BSHIFT;
1771 	sc->sc_bio.databuf = bp->b_data;
1772 	/* Instrumentation. */
1773 	disk_busy(&sc->sc_dk);
1774     sc->active_xfer = bp;
1775     wakeup(&sc->ch_thread);
1776 }
1777 
1778 void
1779 eflashdone(struct eflash_softc *sc)
1780 {
1781 	struct buf *bp = sc->sc_bp;
1782 	const char *errmsg;
1783 	int do_perror = 0;
1784 
1785 	DEBUG_PRINT(("%s: eflashdone %p\n", device_xname(sc->sc_dev), bp),
1786 	    DEBUG_XFERS);
1787 
1788 	if (bp == NULL)
1789 		return;
1790 
1791 	bp->b_resid = sc->sc_bio.nbytes;
1792 	switch (sc->sc_bio.error) {
1793 	case ETIMEDOUT:
1794 		errmsg = "device timeout";
1795         do_perror = 1;
1796 		goto retry;
1797 	case EBUSY:
1798 		errmsg = "device stuck";
1799 retry:		/* Just reset and retry. Can we do more ? */
1800 		/*eflash_reset(sc);*/
1801 		diskerr(bp, "flash", errmsg, LOG_PRINTF,
1802 		    sc->sc_bio.blkdone, sc->sc_dk.dk_label);
1803 		if (sc->retries < EFLASHIORETRIES)
1804 			printf(", retrying");
1805 		printf("\n");
1806 		if (do_perror)
1807 			eflashperror(sc);
1808 		if (sc->retries < EFLASHIORETRIES) {
1809 			sc->retries++;
1810 			callout_reset(&sc->sc_restart_ch, RECOVERYTIME,
1811 			    eflashrestart, sc);
1812 			return;
1813 		}
1814 
1815 		bp->b_error = EIO;
1816 		break;
1817 	case 0:
1818         if ((sc->sc_bio.flags & ATA_CORR) || sc->retries > 0)
1819 			printf("%s: soft error (corrected)\n",
1820 			    device_xname(sc->sc_dev));
1821 		break;
1822 	case ENODEV:
1823 	case E2BIG:
1824 		bp->b_error = EIO;
1825 		break;
1826 	}
1827 	disk_unbusy(&sc->sc_dk, (bp->b_bcount - bp->b_resid),
1828 	    (bp->b_flags & B_READ));
1829 	rnd_add_uint32(&sc->rnd_source, bp->b_blkno);
1830     biodone(bp);
1831     sc->openings++;
1832 	eflashstart(sc);
1833 }
1834 
1835 void
1836 eflashrestart(void *v)
1837 {
1838 	struct eflash_softc *sc = v;
1839 	struct buf *bp = sc->sc_bp;
1840 	int s;
1841 	DEBUG_PRINT(("%s: eflashrestart\n", device_xname(sc->sc_dev)),
1842 	    DEBUG_XFERS);
1843 
1844 	s = splbio();
1845 	__eflashstart(v, bp);
1846 	splx(s);
1847 }
1848 
1849 int
1850 eflashread(dev_t dev, struct uio *uio, int flags)
1851 {
1852 	DEBUG_PRINT(("eflashread\n"), DEBUG_XFERS);
1853 	return (physio(eflashstrategy, NULL, dev, B_READ, minphys, uio));
1854 }
1855 
1856 int
1857 eflashwrite(dev_t dev, struct uio *uio, int flags)
1858 {
1859 	DEBUG_PRINT(("eflashwrite\n"), DEBUG_XFERS);
1860 	return (physio(eflashstrategy, NULL, dev, B_WRITE, minphys, uio));
1861 }
1862 
1863 int
1864 eflashopen(dev_t dev, int flag, int fmt, struct lwp *l)
1865 {
1866 	struct eflash_softc *sc;
1867 	int part, error;
1868 
1869 	DEBUG_PRINT(("eflashopen %" PRIx64 "\n", dev), DEBUG_FUNCS);
1870 	sc = device_lookup_private(&eflash_cd, EFLASHUNIT(dev));
1871 	if (sc == NULL)
1872 		return (ENXIO);
1873 
1874 	if (! device_is_active(sc->sc_dev))
1875 		return (ENODEV);
1876 
1877 	part = EFLASHPART(dev);
1878 
1879 	mutex_enter(&sc->sc_dk.dk_openlock);
1880 
1881 	/*
1882 	 * If there are wedges, and this is not RAW_PART, then we
1883 	 * need to fail.
1884 	 */
1885 	if (sc->sc_dk.dk_nwedges != 0 && part != RAW_PART) {
1886 		error = EBUSY;
1887 		goto bad;
1888 	}
1889 
1890 	if (sc->sc_dk.dk_openmask != 0) {
1891 		/*
1892 		 * If any partition is open, but the disk has been invalidated,
1893 		 * disallow further opens.
1894 		 */
1895 		if ((sc->sc_flags & EFLASHF_LOADED) == 0) {
1896 			error = EIO;
1897 			goto bad;
1898 		}
1899 	} else {
1900 		if ((sc->sc_flags & EFLASHF_LOADED) == 0) {
1901 			sc->sc_flags |= EFLASHF_LOADED;
1902 
1903 			/* Load the partition info if not already loaded. */
1904 			eflashgetdisklabel(sc);
1905 		}
1906 	}
1907 
1908 	/* Check that the partition exists. */
1909 	if (part != RAW_PART &&
1910 	    (part >= sc->sc_dk.dk_label->d_npartitions ||
1911 	     sc->sc_dk.dk_label->d_partitions[part].p_fstype == FS_UNUSED)) {
1912 		error = ENXIO;
1913 		goto bad;
1914 	}
1915 
1916 	/* Insure only one open at a time. */
1917 	switch (fmt) {
1918 	case S_IFCHR:
1919 		sc->sc_dk.dk_copenmask |= (1 << part);
1920 		break;
1921 	case S_IFBLK:
1922 		sc->sc_dk.dk_bopenmask |= (1 << part);
1923 		break;
1924 	}
1925 	sc->sc_dk.dk_openmask =
1926 	    sc->sc_dk.dk_copenmask | sc->sc_dk.dk_bopenmask;
1927 
1928 	mutex_exit(&sc->sc_dk.dk_openlock);
1929 	return 0;
1930 
1931  bad:
1932 	mutex_exit(&sc->sc_dk.dk_openlock);
1933 	DEBUG_PRINT(("%s: eflashopen -> %d\n", device_xname(sc->sc_dev), error),
1934 	    DEBUG_XFERS);
1935 	return error;
1936 }
1937 
1938 int
1939 eflashclose(dev_t dev, int flag, int fmt, struct lwp *l)
1940 {
1941 	struct eflash_softc *sc = device_lookup_private(&eflash_cd, EFLASHUNIT(dev));
1942 	int part = EFLASHPART(dev);
1943 
1944 	DEBUG_PRINT(("eflashclose %" PRIx64 "\n", dev), DEBUG_FUNCS);
1945 
1946 	mutex_enter(&sc->sc_dk.dk_openlock);
1947 
1948 	switch (fmt) {
1949 	case S_IFCHR:
1950 		sc->sc_dk.dk_copenmask &= ~(1 << part);
1951 		break;
1952 	case S_IFBLK:
1953 		sc->sc_dk.dk_bopenmask &= ~(1 << part);
1954 		break;
1955 	}
1956 	sc->sc_dk.dk_openmask =
1957 	    sc->sc_dk.dk_copenmask | sc->sc_dk.dk_bopenmask;
1958 
1959 	if (sc->sc_dk.dk_openmask == 0) {
1960 
1961 		if (! (sc->sc_flags & EFLASHF_KLABEL))
1962 			sc->sc_flags &= ~EFLASHF_LOADED;
1963 
1964         DEBUG_PRINT(("%s: eflashclose flg %x\n", device_xname(sc->sc_dev), sc->sc_flags),
1965                     DEBUG_XFERS);
1966 
1967 	}
1968 
1969 	mutex_exit(&sc->sc_dk.dk_openlock);
1970 	return 0;
1971 }
1972 
1973 void
1974 eflashgetdefaultlabel(struct eflash_softc *sc, struct disklabel *lp)
1975 {
1976 
1977 	DEBUG_PRINT(("%s: eflashgetdefaultlabel\n", device_xname(sc->sc_dev)), DEBUG_FUNCS);
1978 	memset(lp, 0, sizeof(struct disklabel));
1979 
1980 	lp->d_secsize = DEV_BSIZE;
1981 	lp->d_ntracks = 1;
1982 	lp->d_nsectors = sc->sc_capacity;
1983 	lp->d_ncylinders = 1;
1984 	lp->d_secpercyl = lp->d_ntracks * lp->d_nsectors;
1985 
1986 	lp->d_type = DKTYPE_ST506; /* ?!? */
1987 
1988 	strncpy(lp->d_typename, ST506, 16);
1989 	strncpy(lp->d_packname, "fictitious", 16);
1990 	if (sc->sc_capacity > UINT32_MAX)
1991 		lp->d_secperunit = UINT32_MAX;
1992 	else
1993 		lp->d_secperunit = sc->sc_capacity;
1994 	lp->d_rpm = 3600;
1995 	lp->d_interleave = 1;
1996 	lp->d_flags = 0;
1997 
1998 	lp->d_partitions[RAW_PART].p_offset = 0;
1999 	lp->d_partitions[RAW_PART].p_size =
2000 	    lp->d_secperunit * (lp->d_secsize / DEV_BSIZE);
2001 	lp->d_partitions[RAW_PART].p_fstype = FS_UNUSED;
2002 	lp->d_npartitions = RAW_PART + 1;
2003 
2004 	lp->d_magic = DISKMAGIC;
2005 	lp->d_magic2 = DISKMAGIC;
2006 	lp->d_checksum = dkcksum(lp);
2007 }
2008 
2009 /*
2010  * Fabricate a default disk label, and try to read the correct one.
2011  */
2012 void
2013 eflashgetdisklabel(struct eflash_softc *sc)
2014 {
2015 	struct disklabel *lp = sc->sc_dk.dk_label;
2016 	const char *errstring;
2017 
2018 	DEBUG_PRINT(("%s: eflashgetdisklabel\n",  device_xname(sc->sc_dev)), DEBUG_FUNCS);
2019 
2020 	memset(sc->sc_dk.dk_cpulabel, 0, sizeof(struct cpu_disklabel));
2021 
2022 	eflashgetdefaultlabel(sc, lp);
2023 
2024 #ifdef HAS_BAD144_HANDLING
2025 	sc->sc_bio.badsect[0] = -1;
2026 #endif
2027 
2028     /* BUGBUG: maj==0?? why is this not EFLASHLABELDEV(??sc->sc_dev) */
2029 	errstring = readdisklabel(MAKEEFLASHDEV(0, device_unit(sc->sc_dev),
2030 				  RAW_PART), eflashstrategy, lp,
2031 				  sc->sc_dk.dk_cpulabel);
2032 	if (errstring) {
2033 		printf("%s: %s\n", device_xname(sc->sc_dev), errstring);
2034 		return;
2035 	}
2036 
2037 #if DEBUG
2038     if (EFLASH_DEBUG(DEBUG_WRITES)) {
2039         int i, n = sc->sc_dk.dk_label->d_npartitions;
2040         printf("%s: %d parts\n", device_xname(sc->sc_dev), n);
2041         for (i = 0; i < n; i++) {
2042             printf("\t[%d]: t=%x s=%d o=%d\n", i,
2043                    sc->sc_dk.dk_label->d_partitions[i].p_fstype,
2044                    sc->sc_dk.dk_label->d_partitions[i].p_size,
2045                    sc->sc_dk.dk_label->d_partitions[i].p_offset);
2046         }
2047     }
2048 #endif
2049 
2050 #ifdef HAS_BAD144_HANDLING
2051 	if ((lp->d_flags & D_BADSECT) != 0)
2052 		bad144intern(sc);
2053 #endif
2054 }
2055 
2056 void
2057 eflashperror(const struct eflash_softc *sc)
2058 {
2059 	const char *devname = device_xname(sc->sc_dev);
2060 	u_int32_t Status = sc->sc_bio.r_error;
2061 
2062 	printf("%s: (", devname);
2063 
2064 	if (Status == 0)
2065 		printf("error not notified");
2066 	else
2067 		printf("status=x%x", Status);
2068 
2069 	printf(")\n");
2070 }
2071 
2072 int
2073 eflashioctl(dev_t dev, u_long xfer, void *addr, int flag, struct lwp *l)
2074 {
2075 	struct eflash_softc *sc = device_lookup_private(&eflash_cd, EFLASHUNIT(dev));
2076 	int error = 0, s;
2077 
2078 	DEBUG_PRINT(("eflashioctl(%lx)\n",xfer), DEBUG_FUNCS);
2079 
2080 	if ((sc->sc_flags & EFLASHF_LOADED) == 0)
2081 		return EIO;
2082 
2083 	error = disk_ioctl(&sc->sc_dk, dev, xfer, addr, flag, l);
2084 	if (error != EPASSTHROUGH)
2085 		return (error);
2086 
2087 	switch (xfer) {
2088 #ifdef HAS_BAD144_HANDLING
2089 	case DIOCSBAD:
2090 		if ((flag & FWRITE) == 0)
2091 			return EBADF;
2092 		sc->sc_dk.dk_cpulabel->bad = *(struct dkbad *)addr;
2093 		sc->sc_dk.dk_label->d_flags |= D_BADSECT;
2094 		bad144intern(sc);
2095 		return 0;
2096 #endif
2097 
2098 	case DIOCWDINFO:
2099 	case DIOCSDINFO:
2100 	{
2101 		struct disklabel *lp;
2102 
2103 		if ((flag & FWRITE) == 0)
2104 			return EBADF;
2105 
2106 		lp = (struct disklabel *)addr;
2107 
2108 		mutex_enter(&sc->sc_dk.dk_openlock);
2109 		sc->sc_flags |= EFLASHF_LABELLING;
2110 
2111 		error = setdisklabel(sc->sc_dk.dk_label,
2112 		    lp, /*sc->sc_dk.dk_openmask : */0,
2113 		    sc->sc_dk.dk_cpulabel);
2114 		if (error == 0) {
2115 			if (xfer == DIOCWDINFO)
2116 				error = writedisklabel(EFLASHLABELDEV(dev),
2117 				    eflashstrategy, sc->sc_dk.dk_label,
2118 				    sc->sc_dk.dk_cpulabel);
2119 		}
2120 
2121 		sc->sc_flags &= ~EFLASHF_LABELLING;
2122 		mutex_exit(&sc->sc_dk.dk_openlock);
2123 		return error;
2124 	}
2125 
2126 	case DIOCKLABEL:
2127 		if (*(int *)addr)
2128 			sc->sc_flags |= EFLASHF_KLABEL;
2129 		else
2130 			sc->sc_flags &= ~EFLASHF_KLABEL;
2131 		return 0;
2132 
2133 	case DIOCWLABEL:
2134 		if ((flag & FWRITE) == 0)
2135 			return EBADF;
2136 		if (*(int *)addr)
2137 			sc->sc_flags |= EFLASHF_WLABEL;
2138 		else
2139 			sc->sc_flags &= ~EFLASHF_WLABEL;
2140 		return 0;
2141 
2142 	case DIOCGDEFLABEL:
2143 		eflashgetdefaultlabel(sc, (struct disklabel *)addr);
2144 		return 0;
2145 
2146 	case DIOCCACHESYNC:
2147 		return 0;
2148 
2149 	case DIOCGSTRATEGY:
2150 	    {
2151 		struct disk_strategy *dks = (void *)addr;
2152 
2153 		s = splbio();
2154 		strlcpy(dks->dks_name, bufq_getstrategyname(sc->sc_q),
2155 		    sizeof(dks->dks_name));
2156 		splx(s);
2157 		dks->dks_paramlen = 0;
2158 
2159 		return 0;
2160 	    }
2161 
2162 	case DIOCSSTRATEGY:
2163 	    {
2164 		struct disk_strategy *dks = (void *)addr;
2165 		struct bufq_state *new;
2166 		struct bufq_state *old;
2167 
2168 		if ((flag & FWRITE) == 0) {
2169 			return EBADF;
2170 		}
2171 		if (dks->dks_param != NULL) {
2172 			return EINVAL;
2173 		}
2174 		dks->dks_name[sizeof(dks->dks_name) - 1] = 0; /* ensure term */
2175 		error = bufq_alloc(&new, dks->dks_name,
2176 		    BUFQ_EXACT|BUFQ_SORT_RAWBLOCK);
2177 		if (error) {
2178 			return error;
2179 		}
2180 		s = splbio();
2181 		old = sc->sc_q;
2182 		bufq_move(new, old);
2183 		sc->sc_q = new;
2184 		splx(s);
2185 		bufq_free(old);
2186 
2187 		return 0;
2188 	    }
2189 
2190 	default:
2191         /* NB: we get a DIOCGWEDGEINFO, but nobody else handles it either */
2192         DEBUG_PRINT(("eflashioctl: unsup x%lx\n", xfer), DEBUG_FUNCS);
2193 		return ENOTTY;
2194 	}
2195 }
2196 
2197 int
2198 eflashsize(dev_t dev)
2199 {
2200 	struct eflash_softc *sc;
2201 	int part, omask;
2202 	int size;
2203 
2204 	DEBUG_PRINT(("eflashsize\n"), DEBUG_FUNCS);
2205 
2206 	sc = device_lookup_private(&eflash_cd, EFLASHUNIT(dev));
2207 	if (sc == NULL)
2208 		return (-1);
2209 
2210 	part = EFLASHPART(dev);
2211 	omask = sc->sc_dk.dk_openmask & (1 << part);
2212 
2213 	if (omask == 0 && eflashopen(dev, 0, S_IFBLK, NULL) != 0)
2214 		return (-1);
2215 	if (sc->sc_dk.dk_label->d_partitions[part].p_fstype != FS_SWAP)
2216 		size = -1;
2217 	else
2218 		size = sc->sc_dk.dk_label->d_partitions[part].p_size *
2219 		    (sc->sc_dk.dk_label->d_secsize / DEV_BSIZE);
2220 	if (omask == 0 && eflashclose(dev, 0, S_IFBLK, NULL) != 0)
2221 		return (-1);
2222 	return (size);
2223 }
2224 
2225 /*
2226  * Dump core after a system crash.
2227  */
2228 int
2229 eflashdump(dev_t dev, daddr_t blkno, void *va, size_t size)
2230 {
2231     /* no we dont */
2232     return (ENXIO);
2233 }
2234 
2235 #ifdef HAS_BAD144_HANDLING
2236 /*
2237  * Internalize the bad sector table.
2238  */
2239 void
2240 bad144intern(struct eflash_softc *sc)
2241 {
2242 	struct dkbad *bt = &sc->sc_dk.dk_cpulabel->bad;
2243 	struct disklabel *lp = sc->sc_dk.dk_label;
2244 	int i = 0;
2245 
2246 	DEBUG_PRINT(("bad144intern\n"), DEBUG_XFERS);
2247 
2248 	for (; i < NBT_BAD; i++) {
2249 		if (bt->bt_bad[i].bt_cyl == 0xffff)
2250 			break;
2251 		sc->sc_bio.badsect[i] =
2252 		    bt->bt_bad[i].bt_cyl * lp->d_secpercyl +
2253 		    (bt->bt_bad[i].bt_trksec >> 8) * lp->d_nsectors +
2254 		    (bt->bt_bad[i].bt_trksec & 0xff);
2255 	}
2256 	for (; i < NBT_BAD+1; i++)
2257 		sc->sc_bio.badsect[i] = -1;
2258 }
2259 #endif
2260 
2261 static void
2262 eflash_set_geometry(struct eflash_softc *sc)
2263 {
2264 	struct disk_geom *dg = &sc->sc_dk.dk_geom;
2265 
2266 	memset(dg, 0, sizeof(*dg));
2267 
2268 	dg->dg_secperunit = sc->sc_capacity;
2269 	dg->dg_secsize = DEV_BSIZE /* XXX 512? */;
2270 	dg->dg_nsectors = sc->sc_capacity;
2271 	dg->dg_ntracks = 1;
2272 	dg->dg_ncylinders = sc->sc_capacity;
2273 
2274 	disk_set_info(sc->sc_dev, &sc->sc_dk, ST506);
2275 }
2276