1 /* dv-m68hc11eepr.c -- Simulation of the 68HC11 Internal EEPROM.
2 Copyright (C) 1999-2022 Free Software Foundation, Inc.
3 Written by Stephane Carrez (stcarrez@nerim.fr)
4 (From a driver model Contributed by Cygnus Solutions.)
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 /* This must come before any other includes. */
26 #include "sim-assert.h"
27 #include "sim-events.h"
28 #include "sim-signal.h"
38 m68hc11eepr - m68hc11 EEPROM
43 Implements the 68HC11 eeprom device described in the m68hc11
44 user guide (Chapter 4 in the pink book).
51 Base of eeprom and its length.
55 Path of the EEPROM file. The default is 'm6811.eeprom'.
66 /* static functions */
77 static const struct hw_port_descriptor m68hc11eepr_ports
[] =
79 { "reset", RESET_PORT
, 0, input_port
, },
85 /* The timer/counter register internal state. Note that we store
86 state using the control register images, in host endian order. */
90 address_word base_address
; /* control register base */
95 /* Current state of the eeprom programing:
96 - eeprom_wmode indicates whether the EEPROM address and byte have
98 - eeprom_waddr indicates the EEPROM address that was latched
99 and eeprom_wbyte is the byte that was latched.
100 - eeprom_wcycle indicates the CPU absolute cycle type when
101 the high voltage was applied (successfully) on the EEPROM.
103 These data members are setup only when we detect good EEPROM programing
104 conditions (see Motorola EEPROM Programming and PPROG register usage).
105 When the high voltage is switched off, we look at the CPU absolute
106 cycle time to see if the EEPROM command must succeeds or not.
107 The EEPROM content is updated and saved only at that time.
108 (EEPROM command is: byte zero bits program, byte erase, row erase
111 The CONFIG register is programmed in the same way. It is physically
112 located at the end of the EEPROM (eeprom size + 1). It is not mapped
113 in memory but it's saved in the EEPROM file. */
114 unsigned long eeprom_wcycle
;
121 /* Minimum time in CPU cycles for programming the EEPROM. */
122 unsigned long eeprom_min_cycles
;
124 const char* file_name
;
129 /* Finish off the partially created hw device. Attach our local
130 callbacks. Wire up our port names etc. */
132 static hw_io_read_buffer_method m68hc11eepr_io_read_buffer
;
133 static hw_io_write_buffer_method m68hc11eepr_io_write_buffer
;
134 static hw_ioctl_method m68hc11eepr_ioctl
;
136 /* Read or write the memory bank content from/to a file.
137 Returns 0 if the operation succeeded and -1 if it failed. */
139 m6811eepr_memory_rw (struct m68hc11eepr
*controller
, int mode
)
141 const char *name
= controller
->file_name
;
145 size
= controller
->size
;
146 fd
= open (name
, mode
, 0644);
149 if (mode
== O_RDONLY
)
151 memset (controller
->eeprom
, 0xFF, size
);
152 /* Default value for CONFIG register (0xFF should be ok):
153 controller->eeprom[size - 1] = M6811_NOSEC | M6811_NOCOP
154 | M6811_ROMON | M6811_EEON; */
160 if (mode
== O_RDONLY
)
162 if (read (fd
, controller
->eeprom
, size
) != size
)
170 if (write (fd
, controller
->eeprom
, size
) != size
)
185 attach_m68hc11eepr_regs (struct hw
*me
,
186 struct m68hc11eepr
*controller
)
188 unsigned_word attach_address
;
190 unsigned attach_size
;
191 reg_property_spec reg
;
193 if (hw_find_property (me
, "reg") == NULL
)
194 hw_abort (me
, "Missing \"reg\" property");
196 if (!hw_find_reg_array_property (me
, "reg", 0, ®
))
197 hw_abort (me
, "\"reg\" property must contain one addr/size entry");
199 hw_unit_address_to_attach_address (hw_parent (me
),
204 hw_unit_size_to_attach_size (hw_parent (me
),
208 /* Attach the two IO registers that control the EEPROM.
209 The EEPROM is only attached at reset time because it may
210 be enabled/disabled by the EEON bit in the CONFIG register. */
211 hw_attach_address (hw_parent (me
), M6811_IO_LEVEL
,
212 io_map
, M6811_PPROG
, 1, me
);
213 hw_attach_address (hw_parent (me
), M6811_IO_LEVEL
,
214 io_map
, M6811_CONFIG
, 1, me
);
216 if (hw_find_property (me
, "file") == NULL
)
217 controller
->file_name
= "m6811.eeprom";
219 controller
->file_name
= hw_find_string_property (me
, "file");
221 controller
->attach_space
= attach_space
;
222 controller
->base_address
= attach_address
;
223 controller
->eeprom
= hw_malloc (me
, attach_size
+ 1);
224 controller
->eeprom_min_cycles
= 10000;
225 controller
->size
= attach_size
+ 1;
226 controller
->mapped
= 0;
228 m6811eepr_memory_rw (controller
, O_RDONLY
);
232 /* An event arrives on an interrupt port. */
235 m68hc11eepr_port_event (struct hw
*me
,
242 struct m68hc11eepr
*controller
;
245 controller
= hw_data (me
);
247 cpu
= STATE_CPU (sd
, 0);
252 HW_TRACE ((me
, "EEPROM reset"));
254 /* Re-read the EEPROM from the file. This gives the chance
255 to users to erase this file before doing a reset and have
256 a fresh EEPROM taken into account. */
257 m6811eepr_memory_rw (controller
, O_RDONLY
);
259 /* Reset the state of EEPROM programmer. The CONFIG register
260 is also initialized from the EEPROM/file content. */
261 cpu
->ios
[M6811_PPROG
] = 0;
262 if (cpu
->cpu_use_local_config
)
263 cpu
->ios
[M6811_CONFIG
] = cpu
->cpu_config
;
265 cpu
->ios
[M6811_CONFIG
] = controller
->eeprom
[controller
->size
-1];
266 controller
->eeprom_wmode
= 0;
267 controller
->eeprom_waddr
= 0;
268 controller
->eeprom_wbyte
= 0;
270 /* Attach or detach to the bus depending on the EEPROM enable bit.
271 The EEPROM CONFIG register is still enabled and can be programmed
272 for a next configuration (taken into account only after a reset,
273 see Motorola spec). */
274 if (!(cpu
->ios
[M6811_CONFIG
] & M6811_EEON
))
276 if (controller
->mapped
)
277 hw_detach_address (hw_parent (me
), M6811_EEPROM_LEVEL
,
278 controller
->attach_space
,
279 controller
->base_address
,
280 controller
->size
- 1,
282 controller
->mapped
= 0;
286 if (!controller
->mapped
)
287 hw_attach_address (hw_parent (me
), M6811_EEPROM_LEVEL
,
288 controller
->attach_space
,
289 controller
->base_address
,
290 controller
->size
- 1,
292 controller
->mapped
= 1;
298 hw_abort (me
, "Event on unknown port %d", my_port
);
305 m68hc11eepr_finish (struct hw
*me
)
307 struct m68hc11eepr
*controller
;
309 controller
= HW_ZALLOC (me
, struct m68hc11eepr
);
310 set_hw_data (me
, controller
);
311 set_hw_io_read_buffer (me
, m68hc11eepr_io_read_buffer
);
312 set_hw_io_write_buffer (me
, m68hc11eepr_io_write_buffer
);
313 set_hw_ports (me
, m68hc11eepr_ports
);
314 set_hw_port_event (me
, m68hc11eepr_port_event
);
316 set_hw_ioctl (me
, m68hc11eepr_ioctl
);
318 me
->to_ioctl
= m68hc11eepr_ioctl
;
321 attach_m68hc11eepr_regs (me
, controller
);
326 static io_reg_desc pprog_desc
[] = {
327 { M6811_BYTE
, "BYTE ", "Byte Program Mode" },
328 { M6811_ROW
, "ROW ", "Row Program Mode" },
329 { M6811_ERASE
, "ERASE ", "Erase Mode" },
330 { M6811_EELAT
, "EELAT ", "EEProm Latch Control" },
331 { M6811_EEPGM
, "EEPGM ", "EEProm Programming Voltable Enable" },
334 extern io_reg_desc config_desc
[];
337 /* Describe the state of the EEPROM device. */
339 m68hc11eepr_info (struct hw
*me
)
344 struct m68hc11eepr
*controller
;
348 cpu
= STATE_CPU (sd
, 0);
349 controller
= hw_data (me
);
350 base
= cpu_get_io_base (cpu
);
352 sim_io_printf (sd
, "M68HC11 EEprom:\n");
354 val
= cpu
->ios
[M6811_PPROG
];
355 print_io_byte (sd
, "PPROG ", pprog_desc
, val
, base
+ M6811_PPROG
);
356 sim_io_printf (sd
, "\n");
358 val
= cpu
->ios
[M6811_CONFIG
];
359 print_io_byte (sd
, "CONFIG ", config_desc
, val
, base
+ M6811_CONFIG
);
360 sim_io_printf (sd
, "\n");
362 val
= controller
->eeprom
[controller
->size
- 1];
363 print_io_byte (sd
, "(*NEXT*) ", config_desc
, val
, base
+ M6811_CONFIG
);
364 sim_io_printf (sd
, "\n");
366 /* Describe internal state of EEPROM. */
367 if (controller
->eeprom_wmode
)
369 if (controller
->eeprom_waddr
== controller
->size
- 1)
370 sim_io_printf (sd
, " Programming CONFIG register ");
372 sim_io_printf (sd
, " Programming: 0x%04x ",
373 controller
->eeprom_waddr
+ controller
->base_address
);
375 sim_io_printf (sd
, "with 0x%02x\n",
376 controller
->eeprom_wbyte
);
379 sim_io_printf (sd
, " EEProm file: %s\n",
380 controller
->file_name
);
384 m68hc11eepr_ioctl (struct hw
*me
,
385 hw_ioctl_request request
,
388 m68hc11eepr_info (me
);
392 /* generic read/write */
395 m68hc11eepr_io_read_buffer (struct hw
*me
,
402 struct m68hc11eepr
*controller
;
405 HW_TRACE ((me
, "read 0x%08lx %d", (long) base
, (int) nr_bytes
));
408 controller
= hw_data (me
);
409 cpu
= STATE_CPU (sd
, 0);
415 while (nr_bytes
!= 0)
421 *((uint8
*) dest
) = cpu
->ios
[base
];
425 hw_abort (me
, "reading wrong register 0x%04x", base
);
427 dest
= (uint8
*) (dest
) + 1;
435 /* In theory, we can't read the EEPROM when it's being programmed. */
436 if ((cpu
->ios
[M6811_PPROG
] & M6811_EELAT
) != 0
437 && cpu_is_running (cpu
))
439 sim_memory_error (cpu
, SIM_SIGBUS
, base
,
440 "EEprom not configured for reading");
443 base
= base
- controller
->base_address
;
444 memcpy (dest
, &controller
->eeprom
[base
], nr_bytes
);
450 m68hc11eepr_io_write_buffer (struct hw
*me
,
457 struct m68hc11eepr
*controller
;
461 HW_TRACE ((me
, "write 0x%08lx %d", (long) base
, (int) nr_bytes
));
464 controller
= hw_data (me
);
465 cpu
= STATE_CPU (sd
, 0);
467 /* Programming several bytes at a time is not possible. */
468 if (space
!= io_map
&& nr_bytes
!= 1)
470 sim_memory_error (cpu
, SIM_SIGBUS
, base
,
471 "EEprom write error (only 1 byte can be programmed)");
476 hw_abort (me
, "Cannot write more than 1 byte to EEPROM device at a time");
478 val
= *((const uint8
*) source
);
480 /* Write to the EEPROM control register. */
481 if (space
== io_map
&& base
== M6811_PPROG
)
486 addr
= base
+ cpu_get_io_base (cpu
);
488 /* Setting EELAT and EEPGM at the same time is an error.
489 Clearing them both is ok. */
490 wrong_bits
= (cpu
->ios
[M6811_PPROG
] ^ val
) & val
;
491 wrong_bits
&= (M6811_EELAT
| M6811_EEPGM
);
493 if (wrong_bits
== (M6811_EEPGM
|M6811_EELAT
))
495 sim_memory_error (cpu
, SIM_SIGBUS
, addr
,
496 "Wrong eeprom programing value");
500 if ((val
& M6811_EELAT
) == 0)
504 if ((val
& M6811_EEPGM
) && !(cpu
->ios
[M6811_PPROG
] & M6811_EELAT
))
506 sim_memory_error (cpu
, SIM_SIGBUS
, addr
,
507 "EEProm high voltage applied after EELAT");
509 if ((val
& M6811_EEPGM
) && controller
->eeprom_wmode
== 0)
511 sim_memory_error (cpu
, SIM_SIGSEGV
, addr
,
512 "EEProm high voltage applied without address");
514 if (val
& M6811_EEPGM
)
516 controller
->eeprom_wcycle
= cpu_current_cycle (cpu
);
518 else if (cpu
->ios
[M6811_PPROG
] & M6811_PPROG
)
521 unsigned long t
= cpu_current_cycle (cpu
);
523 t
-= controller
->eeprom_wcycle
;
524 if (t
< controller
->eeprom_min_cycles
)
526 sim_memory_error (cpu
, SIM_SIGILL
, addr
,
527 "EEprom programmed only for %lu cycles",
531 /* Program the byte by clearing some bits. */
532 if (!(cpu
->ios
[M6811_PPROG
] & M6811_ERASE
))
534 controller
->eeprom
[controller
->eeprom_waddr
]
535 &= controller
->eeprom_wbyte
;
538 /* Erase a byte, row or the complete eeprom. Erased value is 0xFF.
539 Ignore row or complete eeprom erase when we are programming the
540 CONFIG register (last EEPROM byte). */
541 else if ((cpu
->ios
[M6811_PPROG
] & M6811_BYTE
)
542 || controller
->eeprom_waddr
== controller
->size
- 1)
544 controller
->eeprom
[controller
->eeprom_waddr
] = 0xff;
546 else if (cpu
->ios
[M6811_BYTE
] & M6811_ROW
)
550 /* Size of EEPROM (-1 because the last byte is the
552 max_size
= controller
->size
;
553 controller
->eeprom_waddr
&= 0xFFF0;
555 && controller
->eeprom_waddr
< max_size
; i
++)
557 controller
->eeprom
[controller
->eeprom_waddr
] = 0xff;
558 controller
->eeprom_waddr
++;
565 max_size
= controller
->size
;
566 for (i
= 0; i
< max_size
; i
++)
568 controller
->eeprom
[i
] = 0xff;
572 /* Save the eeprom in a file. We have to save after each
573 change because the simulator can be stopped or crash... */
574 if (m6811eepr_memory_rw (controller
, O_WRONLY
| O_CREAT
) != 0)
576 sim_memory_error (cpu
, SIM_SIGABRT
, addr
,
577 "EEPROM programing failed: errno=%d", errno
);
579 controller
->eeprom_wmode
= 0;
581 cpu
->ios
[M6811_PPROG
] = val
;
585 /* The CONFIG IO register is mapped at end of EEPROM.
587 if (space
== io_map
&& base
== M6811_CONFIG
)
589 base
= controller
->size
- 1;
593 base
= base
- controller
->base_address
;
596 /* Writing the memory is allowed for the Debugger or simulator
597 (cpu not running). */
598 if (cpu_is_running (cpu
))
600 if ((cpu
->ios
[M6811_PPROG
] & M6811_EELAT
) == 0)
602 sim_memory_error (cpu
, SIM_SIGSEGV
, base
,
603 "EEprom not configured for writing");
606 if (controller
->eeprom_wmode
!= 0)
608 sim_memory_error (cpu
, SIM_SIGSEGV
, base
,
609 "EEprom write error");
612 controller
->eeprom_wmode
= 1;
613 controller
->eeprom_waddr
= base
;
614 controller
->eeprom_wbyte
= val
;
618 controller
->eeprom
[base
] = val
;
619 m6811eepr_memory_rw (controller
, O_WRONLY
);
625 const struct hw_descriptor dv_m68hc11eepr_descriptor
[] = {
626 { "m68hc11eepr", m68hc11eepr_finish
},
627 { "m68hc12eepr", m68hc11eepr_finish
},