Checklist for Cleaning Up Drivers - Revision history

Ajr at 18:52, 17 November 2017

2017-11-17T18:52:44Z

← Older revision		Revision as of 20:52, 17 November 2017
Line 14:		Line 14:
	* convert memory banking to the new system (memory_configure_bank)		* convert memory banking to the new system (memory_configure_bank)
	* use address_map_bank_device for banking RAM or peripherals over ROM		* use address_map_bank_device for banking RAM or peripherals over ROM
			* split up do-everything I/O block handlers that control multiple unrelated components

	'''Graphics:'''		'''Graphics:'''

Ajr at 03:47, 16 September 2017

2017-09-16T03:47:37Z

← Older revision		Revision as of 05:47, 16 September 2017
Line 13:		Line 13:
	* use AM_SHARE where appropriate (better than sharedram read/write handlers)		* use AM_SHARE where appropriate (better than sharedram read/write handlers)
	* convert memory banking to the new system (memory_configure_bank)		* convert memory banking to the new system (memory_configure_bank)
			* use address_map_bank_device for banking RAM or peripherals over ROM

	'''Graphics:'''		'''Graphics:'''
Line 24:		Line 25:
	* add limits on sprite drawing (e.g., how many per scanline), if known		* add limits on sprite drawing (e.g., how many per scanline), if known

	'''Inputs:'''		'''Inputs/Outputs:'''
	* tag all input ports
	* change all port references in code to use tags
	* convert non-DIP configurations to configs		* convert non-DIP configurations to configs
	* use PORT_CUSTOM where appropriate instead of memory overrides		* use PORT_CUSTOM where appropriate instead of memory overrides
	* connect coin counters (often missing)		* connect coin counters (often missing)
			* connect hopper output and feedback for betting games (payout buttons usually cause errors if this is not done)
	* connect PCB outputs via the new output system		* connect PCB outputs via the new output system
	* add DIPLOCATIONS		* add DIPLOCATIONS
Line 35:		Line 35:

	'''ROMs:'''		'''ROMs:'''
	* memory regions reduced to minimum size (they don't have to cover the whole address space)		* memory regions reduced to minimum size (they don't have to cover the whole address space; note that AM_REGION makes this possible with CPU types like 6502, 6809 and x86 on which execution has to start from near the end of addressable memory)
	* make sure ROM names are good and accurate to what we know		* make sure ROM names are good and accurate to what we know
	* check for any unemulated clones		* check for any unemulated clones

Madskunk: Simple Wiki formatting changes

2008-06-28T11:35:08Z

Simple Wiki formatting changes

← Older revision		Revision as of 13:35, 28 June 2008
Line 1:		Line 1:
	Over the past year(s), Aaron has done some driver "cleanup" work. This generally involves picking apart a driver, revisiting all the assumptions using whatever information is available, and updating it to take advantage of newer features in MAME that have been introduced since it was first written. To do this work, Aaron keeps a checklist of things to do, just to make sure all bases are covered. This list is constantly updated, but since it is a good set of guidelines for updating a driver, or writing a new one from scratch, it is provided here.		Over the past year(s), Aaron has done some driver "cleanup" work. This generally involves picking apart a driver, revisiting all the assumptions using whatever information is available, and updating it to take advantage of newer features in MAME that have been introduced since it was first written. To do this work, Aaron keeps a checklist of things to do, just to make sure all bases are covered. This list is constantly updated, but since it is a good set of guidelines for updating a driver, or writing a new one from scratch, it is provided here.

	~~<b>~~Timing/interrupts:~~</b>~~		'''Timing/interrupts:'''
	~~<ul><li>~~all crystals on the PCB documented via #defines~~</li>~~		* all crystals on the PCB documented via #defines
	~~<li>~~all CPU and sound clocks derived from #defined crystal values~~</li>~~		* all CPU and sound clocks derived from #defined crystal values
	~~<li>~~re-verify interrupt generation timing and sources~~</li> <li>~~implement interrupt acknowledges (many older drivers didn't bother)~~</li>~~		* re-verify interrupt generation timing and sources
	~~<li>~~add accurate watchdog durations~~</li> </ul>~~		* implement interrupt acknowledges (many older drivers didn't bother)
			*add accurate watchdog durations

	~~<b>~~Memory:~~</b>~~		'''Memory:'''
	~~<ul><li>~~unified read/write memory maps (they used to be separate)~~</li>~~		* unified read/write memory maps (they used to be separate)
	~~<li>~~map the entire address space fully, if possible from schematics~~</li>~~		* map the entire address space fully, if possible from schematics
	~~<li>~~use AM_SHARE where appropriate (better than sharedram read/write handlers)~~</li> <li>~~convert memory banking to the new system (memory_configure_bank)~~</li> </ul>~~		* use AM_SHARE where appropriate (better than sharedram read/write handlers)
			* convert memory banking to the new system (memory_configure_bank)

	~~<b>~~Graphics:~~</b>~~		'''Graphics:'''
	~~<ul><li>~~gfx layouts should use RGN_FRAC wherever possible instead of hard-coded values~~</li>~~		* gfx layouts should use RGN_FRAC wherever possible instead of hard-coded values
	~~<li>~~gfx layouts that are common should be shared (vidhrdw/generic.c)~~</li>~~		* gfx layouts that are common should be shared (vidhrdw/generic.c)
	~~<li>~~accurate hblank/vblank/visible areas, derived from schematics if possible~~</li>~~		* accurate hblank/vblank/visible areas, derived from schematics if possible
	~~<li>~~convert from old macros to new screen macros for display info~~</li>~~		* convert from old macros to new screen macros for display info
	~~<li>~~use new more accurate screen timing routines for H/V positions~~</li>~~		* use new more accurate screen timing routines for H/V positions
	~~<li>~~convert to tilemaps, if applicable~~</li>~~		* convert to tilemaps, if applicable
	~~<li>~~change to use resistors for palette generation~~</li>~~		* change to use resistors for palette generation
	~~<li>~~add limits on sprite drawing (e.g., how many per scanline), if known~~</li> </ul>~~		* add limits on sprite drawing (e.g., how many per scanline), if known

	~~<b>~~Inputs:~~</b>~~		'''Inputs:'''
	~~<ul><li>~~tag all input ports~~</li>~~		* tag all input ports
	~~<li>~~change all port references in code to use tags~~</li>~~		* change all port references in code to use tags
	~~<li>~~convert non-DIP configurations to configs~~</li>~~		* convert non-DIP configurations to configs
	~~<li>~~use PORT_CUSTOM where appropriate instead of memory overrides~~</li>~~		* use PORT_CUSTOM where appropriate instead of memory overrides
	~~<li>~~connect coin counters (often missing)~~</li>~~		* connect coin counters (often missing)
	~~<li>~~connect PCB outputs via the new output system~~</li>~~		* connect PCB outputs via the new output system
	~~<li>~~add DIPLOCATIONS~~</li>~~		* add DIPLOCATIONS
	~~<li>~~verify DIPs and inputs~~</li> </ul>~~		* verify DIPs and inputs

	~~<b>~~ROMs:~~</b>~~		'''ROMs:'''
	~~<ul><li>~~memory regions reduced to minimum size (they don't have to cover the whole address space)~~</li>~~		* memory regions reduced to minimum size (they don't have to cover the whole address space)
	~~<li>~~make sure ROM names are good and accurate to what we know~~</li>~~		* make sure ROM names are good and accurate to what we know
	~~<li>~~check for any unemulated clones~~</li> </ul>~~		* check for any unemulated clones

	~~<b>General:</b>~~
	~~<ul><li>update source files to be in order: header, includes, constants, typedefs, macros, globals, inlines, code</li>~~
	~~<li>update driver file to be in the same order, followed by: address maps, input ports, graphics definitions, sound configs, machine driver, ROMs, driver init code, drivers</li>~~
	~~<li>add save state support</li>~~
	~~<li>move all globals to hang off of driver_data</li>~~
	~~<li>de-obfuscate the code where it is confusing</li> </ul>~~

			'''General:'''
			* update source files to be in order: header, includes, constants, typedefs, macros, globals, inlines, code
			* update driver file to be in the same order, followed by: address maps, input ports, graphics definitions, sound configs, machine driver, ROMs, driver init code, drivers
			* add save state support
			* move all globals to hang off of driver_data
			* de-obfuscate the code where it is confusing

	Some recent driver updates that are pretty up to date include: <code>ccastles.c, cloud9.c, missile.c, turbo.c, zaxxon.c.</code>		Some recent driver updates that are pretty up to date include: <code>ccastles.c, cloud9.c, missile.c, turbo.c, zaxxon.c.</code>

Madskunk at 13:23, 24 June 2008

2008-06-24T13:23:47Z

← Older revision		Revision as of 15:23, 24 June 2008
Line 1:		Line 1:
	Over the past year, ~~I've~~ done some driver "cleanup" work. This generally involves picking apart a driver, revisiting all the assumptions using whatever information is available, and updating it to take advantage of newer features in MAME that have been introduced since it was first written. To do this work, ~~I keep~~ a checklist of things to do, just to make sure ~~I've covered~~ all ~~the~~ bases. This list is constantly updated, but ~~I figured I would share it,~~ since it is a good set of guidelines ~~when~~ updating a driver or writing a new one from scratch.		Over the past year(s), Aaron has done some driver "cleanup" work. This generally involves picking apart a driver, revisiting all the assumptions using whatever information is available, and updating it to take advantage of newer features in MAME that have been introduced since it was first written. To do this work, Aaron keeps a checklist of things to do, just to make sure all bases are covered. This list is constantly updated, but since it is a good set of guidelines for updating a driver, or writing a new one from scratch, it is provided here.

	<b>Timing/interrupts:</b>		<b>Timing/interrupts:</b>
	<ul>		<ul><li>all crystals on the PCB documented via #defines</li>
	<li>all crystals on the PCB documented via #defines</li> <li>all CPU and sound clocks derived from #defined crystal values</li> <li>re-verify interrupt generation timing and sources</li> <li>implement interrupt acknowledges (many older drivers didn't bother)</li> <li>add accurate watchdog durations</li> </ul>		<li>all CPU and sound clocks derived from #defined crystal values</li>
			<li>re-verify interrupt generation timing and sources</li> <li>implement interrupt acknowledges (many older drivers didn't bother)</li>
			<li>add accurate watchdog durations</li> </ul>

	<b>Memory:</b>		<b>Memory:</b>
	<ul>		<ul><li>unified read/write memory maps (they used to be separate)</li>
	<li>unified read/write memory maps (they used to be separate)</li> <li>map the entire address space fully, if possible from schematics</li> <li>use AM_SHARE where appropriate (better than sharedram read/write handlers)</li> <li>convert memory banking to the new system (memory_configure_bank)</li> </ul>		<li>map the entire address space fully, if possible from schematics</li>
			<li>use AM_SHARE where appropriate (better than sharedram read/write handlers)</li> <li>convert memory banking to the new system (memory_configure_bank)</li> </ul>

	<b>Graphics:</b>		<b>Graphics:</b>
	<ul>		<ul><li>gfx layouts should use RGN_FRAC wherever possible instead of hard-coded values</li>
	<li>gfx layouts should use RGN_FRAC wherever possible instead of hard-coded values</li> <li>gfx layouts that are common should be shared (vidhrdw/generic.c)</li> <li>accurate hblank/vblank/visible areas, derived from schematics if possible</li> <li>convert from old macros to new screen macros for display info</li> <li>use new more accurate screen timing routines for H/V positions</li> <li>convert to tilemaps, if applicable</li> <li>change to use resistors for palette generation</li> <li>add limits on sprite drawing (i.e., how many per scanline) if known</li> </ul>		<li>gfx layouts that are common should be shared (vidhrdw/generic.c)</li>
			<li>accurate hblank/vblank/visible areas, derived from schematics if possible</li>
			<li>convert from old macros to new screen macros for display info</li>
			<li>use new more accurate screen timing routines for H/V positions</li>
			<li>convert to tilemaps, if applicable</li>
			<li>change to use resistors for palette generation</li>
			<li>add limits on sprite drawing (e.g., how many per scanline), if known</li> </ul>

	<b>Inputs:</b>		<b>Inputs:</b>
	<ul>		<ul><li>tag all input ports</li>
	<li>tag all input ports</li>		<li>change all port references in code to use tags</li>
	<li>change all port references in code to use tags</li> <li>convert non-DIP configurations to configs</li> <li>use PORT_CUSTOM where appropriate instead of memory overrides</li> <li>connect coin counters (often missing)</li> <li>connect PCB outputs via the new output system</li> <li>add DIPLOCATIONS</li> <li>verify DIPs and inputs</li> </ul>		<li>convert non-DIP configurations to configs</li>
			<li>use PORT_CUSTOM where appropriate instead of memory overrides</li>
			<li>connect coin counters (often missing)</li>
			<li>connect PCB outputs via the new output system</li>
			<li>add DIPLOCATIONS</li>
			<li>verify DIPs and inputs</li> </ul>

	<b>ROMs:</b>		<b>ROMs:</b>
	<ul>		<ul><li>memory regions reduced to minimum size (they don't have to cover the whole address space)</li>
	<li>memory regions reduced to minimum size (they don't have to cover the whole address space)</li> <li>make sure ROM names are good and accurate to what we know</li> <li>check for any unemulated clones</li> </ul>		<li>make sure ROM names are good and accurate to what we know</li>
			<li>check for any unemulated clones</li> </ul>

	<b>General:</b>		<b>General:</b>
	<ul>		<ul><li>update source files to be in order: header, includes, constants, typedefs, macros, globals, inlines, code</li>
	<li>update source files to be in order: header, includes, constants, typedefs, macros, globals, inlines, code</li> <li>update driver file to be in the same order, followed by: address maps, input ports, graphics definitions, sound configs, machine driver, ROMs, driver init code, drivers</li> <li>add save state support</li> <li>move all globals to hang off of driver_data</li> <li>de-obfuscate the code where it is confusing</li> </ul>		<li>update driver file to be in the same order, followed by: address maps, input ports, graphics definitions, sound configs, machine driver, ROMs, driver init code, drivers</li>
			<li>add save state support</li>
			<li>move all globals to hang off of driver_data</li>
			<li>de-obfuscate the code where it is confusing</li> </ul>

	~~Actually, that's quite a lot of stuff. I'm sure I've missed a thing or two in some of my~~ recent driver updates~~, but some examples~~ that are pretty up to date include: ccastles.c, cloud9.c, missile.c, turbo.c, zaxxon.c.
			Some recent driver updates that are pretty up to date include: <code>ccastles.c, cloud9.c, missile.c, turbo.c, zaxxon.c.</code>

Madskunk: New page: Over the past year, I've done some driver "cleanup" work. This generally involves picking apart a driver, revisiting all the assumptions using whatever information is available, and updati...

2008-06-24T13:15:34Z

New page: Over the past year, I've done some driver "cleanup" work. This generally involves picking apart a driver, revisiting all the assumptions using whatever information is available, and updati...

New page

Over the past year, I've done some driver "cleanup" work. This generally involves picking apart a driver, revisiting all the assumptions using whatever information is available, and updating it to take advantage of newer features in MAME that have been introduced since it was first written. To do this work, I keep a checklist of things to do, just to make sure I've covered all the bases. This list is constantly updated, but I figured I would share it, since it is a good set of guidelines when updating a driver or writing a new one from scratch.

Timing/interrupts:
<ul>
<li>all crystals on the PCB documented via #defines</li> <li>all CPU and sound clocks derived from #defined crystal values</li> <li>re-verify interrupt generation timing and sources</li> <li>implement interrupt acknowledges (many older drivers didn't bother)</li> <li>add accurate watchdog durations</li> </ul>

Memory:
<ul>
<li>unified read/write memory maps (they used to be separate)</li> <li>map the entire address space fully, if possible from schematics</li> <li>use AM_SHARE where appropriate (better than sharedram read/write handlers)</li> <li>convert memory banking to the new system (memory_configure_bank)</li> </ul>

Graphics:
<ul>
<li>gfx layouts should use RGN_FRAC wherever possible instead of hard-coded values</li> <li>gfx layouts that are common should be shared (vidhrdw/generic.c)</li> <li>accurate hblank/vblank/visible areas, derived from schematics if possible</li> <li>convert from old macros to new screen macros for display info</li> <li>use new more accurate screen timing routines for H/V positions</li> <li>convert to tilemaps, if applicable</li> <li>change to use resistors for palette generation</li> <li>add limits on sprite drawing (i.e., how many per scanline) if known</li> </ul>

Inputs:
<ul>
<li>tag all input ports</li>
<li>change all port references in code to use tags</li> <li>convert non-DIP configurations to configs</li> <li>use PORT_CUSTOM where appropriate instead of memory overrides</li> <li>connect coin counters (often missing)</li> <li>connect PCB outputs via the new output system</li> <li>add DIPLOCATIONS</li> <li>verify DIPs and inputs</li> </ul>

ROMs:
<ul>
<li>memory regions reduced to minimum size (they don't have to cover the whole address space)</li> <li>make sure ROM names are good and accurate to what we know</li> <li>check for any unemulated clones</li> </ul>

General:
<ul>
<li>update source files to be in order: header, includes, constants, typedefs, macros, globals, inlines, code</li> <li>update driver file to be in the same order, followed by: address maps, input ports, graphics definitions, sound configs, machine driver, ROMs, driver init code, drivers</li> <li>add save state support</li> <li>move all globals to hang off of driver_data</li> <li>de-obfuscate the code where it is confusing</li> </ul>

Actually, that's quite a lot of stuff. I'm sure I've missed a thing or two in some of my recent driver updates, but some examples that are pretty up to date include: ccastles.c, cloud9.c, missile.c, turbo.c, zaxxon.c.