flat assembler
Message board for the users of flat assembler.
![]() |
Author |
|
Tomasz Grysztar
I'm still working on adding more examples to manual and is becoming a bit better in this aspect in recent versions.
As for the formatting - it is already available in different versions: plain text, PDF and HTML, and each one uses some convention to differ the code and keywords from the other text. Or do you mean something different? |
|||
![]() |
|
shaolin007
The only one I have seen is the HTML version but heres a example of what I was talking about.
"The following assumptions and conventions are adopted to provide clarity and ease of use. The words set and clear imply that a register bit or a condition contains the values logical 1 and logical 0, respectively. When either of these terms is followed by a number, the word logical may not be included, but it is implied. A field of bits within a register is designated as: Register (n–n). For example: PWM_CR (31–20). A field of bits within a bus is designated as: Bus n–n . For example: PCntl 7–4 . A range of similar (whole) registers is designated as: Registern–Registern. For example: In this document, the terms LSB and MSB, when appearing in upper case, mean least significant byte and most significant byte, respectively. The lowercase forms, msb and lsb, mean least significant bit and most significant bit, respectively. Commands, code lines and fragments, register (and other) mnemonics, values, equations, and various executable items are distinguished from general text by the use of the Courier font. This convention is not used within tables. For example: The STP bit in the CNTR register must be 1. Where the use of the font is not possible, as in the Index, the name of the entity is presented in upper case. Hexadecimal values are designated by a uppercase H and appear in the Courier typeface. For example: STAT is set to F8H The use of all uppercase letters designates the names of states and commands. For example: The receiver can force the SCL line to Low to force the transmitter into a WAIT state. The bus is considered BUSY after the Start condition. A START command triggers the processing of the initialization sequence. Initial uppercase letters designate settings, modes, and conditions in general text. For example: The Slave receiver leaves the data line High. In Transmit mode, the byte is sent most significant bit first. The Master can generate a Stop condition to abort the transfer. Register access is designated by the following abbreviations: Z80, Z180, Z380 and Z80382 are trademarks of ZiLOG, Inc. Designation Description R Read Only R/W Read/Write W Write O nly – Unspecified or indeterminate" That was copied from my Z-80 manual. Probably the better example is whats in my Sound Blaster 16 programming guide. It is formatted very well, easy to follow and easy to read but I couldn't copy the text to show you. Obviously, this is all at your descretion to format the document how you see fit. |
|||
![]() |
|
< Last Thread | Next Thread > |
Forum Rules:
|
Copyright © 1999-2020, Tomasz Grysztar. Also on GitHub, YouTube, Twitter.
Website powered by rwasa.