Home

Welcome to the SuccOS wiki!

Cli Functions

Functions relating to the file cli.asm TODO

Cmos Functions

Functions relating to the file cmos.asm

• cmosRead - Read the contents from a chosen CMOS register
• cmosWrite - Write to the chosen CMOS register
• cmosReadDate - Get the system date from the CMOS
• cmosReadTime - Get the system time from the CMOS
• cmosDelay - Use the CMOS to wait a period of time in seconds
• bcd - Convert a value into a binary-coded decimal (BCD)

Disk Functions

Functions relating to the file disk.asm TODO

Fat Functions

Functions relating to the file fat.asm

• readClustersFAT12 - Read the data from FAT12 clusters into memory
• readClustersFAT16 - Read the data from FAT16 clusters into memory
• readClusters - Use FAT12 or FAT16, then read the clusters from the disk
• removeClustersFAT12 - Remove FAT12 clusters from the FAT table
• removeClustersFAT16 - Remove FAT16 clusters from the FAT table
• removeClusters - Determine to use FAT12 or FAT16, then remove the clusters from the FAT
• writeClustersFAT12 - Write new FAT12 clusters and data to the disk
• writeClustersFAT16 - Write new FAT16 clusters and data to the disk
• writeClusters - Determine to use FAT12 or FAT16, then write clusters to the disk

Kernel Functions

Functions relating to the file kernel.asm

TODO

Memory Functions

Functions relating to the file memory.asm

• setupMemory - Get the inital low memory and allocate areas into the memory map
• memBytesToBlocks32 - Calculate how many blocks are required to allocate from the size in bytes
• memBlockToAddress - Convert the block into a segment and offset address
• memAddressToBlock - Convert the segment and offset address into a block
• memAllocNextBlock - Allocate the next available block in memory
• memAllocBlocks - Allocate the next available blocks in memory
• memAllocBytes - Allocate the next available bytes in memory
• memFreeBlock - Free the block in memory related to the address
• memFreeBlocks - Free the blocks in memory related to the address
• memFreeBytes - Free the bytes in memory related to the address
• allocMemAddress - Manually allocate an address into memory

Serial Functions

Functions relating to the file serial.asm

• initSerial - Setup the serial (com1) port
• writeSerial - Write some data to the serial port
• readSerial - Read some data from the serial port
• writeSerialStr - Write a string to the serial port
• writeSerialNumPadding32 - Write a formatted number to the serial port

String Functions

Functions relating to the file string.asm

• itoa - Converts a 32-bit number and base to a string
• atoi - Converts a string and base to a 16-bit number
• convertFilename83 - Convert the filename into a fat formatted filename (8.3 format)
• padStr - Pad a string with Ascii characters
• parseStr - Split the string into tokens
• strCmp - Checks to see if the two passed strings are equal to each other or not
• strLen - Get the length of a string
• charToLower - Convert an Acsii letter to a lowercase character
• charToUpper - Convert an Acsii letter to a uppercase character

Video Functions

Functions relating to the file video.asm TODO

• setupVideo - Get the cursor position from the BIOS, then save for use
• videoWriteChar - Write a character into video memory
• videoWriteStr - Write a string into video memory
• videoWriteNumPadding32 - Write a 32-bit number into video memory with padding
• videoWriteNumPadding - Write a 16-bit number into video memory with padding
• videoWriteNum32 - Write a 32-bit number into video memory
• videoWriteNum - Write a 16-bit number into video memory
• videoScroll - Scroll the screen up one line, if cursor is on the last available line.
• videoClearScreen - Clear the screen of text
• videoSaveScreen - Save the contents of the screen into memory
• videoRestoreScreen - Restore the contents of the screen from memory
• videoUpdateBiosCur - Update the BIOS cursor
• videoUpdateCur - Update the hardware cursor