YMF262DevBoardSoftware/docs-src/mainpage.md

@page mainpage Yamaha YMF262 Development Board

This manual provides precise instructions for operating the development board equipped with the YMF262 (OPL3) integrated circuit. The board allows for direct control of the YMF262 through accessible pins, facilitating practical experimentation and integration into custom solutions. This guide covers connection, configuration, and programming of the YMF262 for a range of applications.

About this Document

This document covers both the software implementation, including a comprehensive overview of the library used to interface with the IC, and the hardware aspects of the development board. It also provides fundamental concepts related to the YMF262 IC.

This manual is structured as follows:

• About the Board
• Fundamentals of FM Synthesis and Sound Creation
• Library Documentation

About the YMF262

The YMF262 is a Yamaha-made chip, developed in 1994 and used on multiple sound cards.

The chip, referred to as OPL3 (Operator Type L 3), implements FM Synthesis for sound generation. It can operate in two modes: the two-operator mode, with 18 operators for up to 9 melodic channels, and the four-operator mode, supporting up to 6 channels. The YMF262 includes dedicated circuitry for generating drum and rhythm sounds, such as bass drum, snare drum, tom tom, top cymbal, and hi-hat. The chip accepts a 14.31818 MHz clock input, features programmable registers for sound control, and supports vibrato, tremolo, and envelope shaping for each channel.

It also has a stereo output and is compatible with OPL2 mode (YM3812)

Architecture of the Board

@dot digraph Connection { rankdir=LR; ranksep=2.0; node [shape=record fontname="Helvetica" fontsize=10];

J1 [label="{J1|{
    <gnd>  1  GND  |
    <d0>   2  D0   |
    <d1>   3  D1   |
    <d2>   4  D2   |
    <d3>   5  D3   |
    <d4>   6  D4   |
    <d5>   7  D5   |
    <d6>   8  D6   |
    <d7>   9  D7   |
    <a0>   10 A0   |
    <a1>   11 A1   |
    <wr>   12 /WR  |
    <rd>   13 /RD  |
    <cs>   14 /CS  |
    <ic>   15 /IC
}}"];

YMF262 [label="{{
    <irq>  /IRQ (2)  |
    <ic>   /IC  (3)  |
    <a0>   A0   (4)  |
    <a1>   A1   (5)  |
    <wr>   /WR  (6)  |
    <rd>   /RD  (7)  |
    <cs>   /CS  (8)  |
    <d0>   D0   (10) |
    <d1>   D1   (11) |
    <d2>   D2   (13) |
    <d3>   D3   (14) |
    <d4>   D4   (15) |
    <d5>   D5   (16) |
    <d6>   D6   (17) |
    <d7>   D7   (18)
}|YMF262}"];

// Data bus - azul
J1:d0 -> YMF262:d0 [color=blue];
J1:d1 -> YMF262:d1 [color=blue];
J1:d2 -> YMF262:d2 [color=blue];
J1:d3 -> YMF262:d3 [color=blue];
J1:d4 -> YMF262:d4 [color=blue];
J1:d5 -> YMF262:d5 [color=blue];
J1:d6 -> YMF262:d6 [color=blue];
J1:d7 -> YMF262:d7 [color=blue];

// Address bus - verde
J1:a0 -> YMF262:a0 [color=darkgreen];
J1:a1 -> YMF262:a1 [color=darkgreen];

// Control - vermelho
J1:wr -> YMF262:wr [color=red];
J1:rd -> YMF262:rd [color=red];
J1:cs -> YMF262:cs [color=red];
J1:ic -> YMF262:ic [color=red];

} @enddot