c++/rgb-assembler/memory.h
author František Kučera <franta-hg@frantovo.cz>
Sun, 24 Dec 2017 00:30:54 +0100
changeset 29 10d6964e7b4a
parent 20 b9ceffdcaf14
child 31 b997cbf9e30b
permissions -rw-r--r--
license: GNU GPLv3+
franta-hg@29
     1
/**
franta-hg@29
     2
 * RGB assembler
franta-hg@29
     3
 * Copyright © 2017 František Kučera (frantovo.cz)
franta-hg@29
     4
 *
franta-hg@29
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@29
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@29
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@29
     8
 * (at your option) any later version.
franta-hg@29
     9
 *
franta-hg@29
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@29
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@29
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@29
    13
 * GNU General Public License for more details.
franta-hg@29
    14
 *
franta-hg@29
    15
 * You should have received a copy of the GNU General Public License
franta-hg@29
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@29
    17
 */
franta-hg@29
    18
franta-hg@20
    19
#pragma once
franta-hg@20
    20
franta-hg@20
    21
#include "types.h"
franta-hg@20
    22
franta-hg@20
    23
const address_t MEMORY_SIZE = 1024;
franta-hg@20
    24
franta-hg@20
    25
template<typename T> T logMemoryError(const address_t &index) {
franta-hg@20
    26
	wprintf(L"memory error: index = %d, sizeof(T) = %d, MEMORY_SIZE = %d\n", index, sizeof (T), MEMORY_SIZE);
franta-hg@20
    27
	// TODO: return error value or throw exception
franta-hg@20
    28
	return T();
franta-hg@20
    29
}
franta-hg@20
    30
franta-hg@20
    31
/**
franta-hg@20
    32
 * Reads data on given position in memory and increments the index (position).
franta-hg@20
    33
 * 
franta-hg@20
    34
 * @param memory array of bytes / octets
franta-hg@20
    35
 * @param index offset in same units as memory type
franta-hg@20
    36
 * @return value found at given position
franta-hg@20
    37
 */
franta-hg@20
    38
template<typename T> T read(octet_t * memory, address_t &index) {
franta-hg@20
    39
	// TODO: map higher memory to static hardcoded areas or peripherals
franta-hg@20
    40
	if (index + sizeof (T) <= MEMORY_SIZE) {
franta-hg@20
    41
		T * value = reinterpret_cast<T*> (memory + index);
franta-hg@20
    42
		index += sizeof (T);
franta-hg@20
    43
		return *value;
franta-hg@20
    44
	} else {
franta-hg@20
    45
		return logMemoryError<T>(index);
franta-hg@20
    46
	}
franta-hg@20
    47
}
franta-hg@20
    48
franta-hg@20
    49
/**
franta-hg@20
    50
 * Writes data to given position in memory and increments the index (position).
franta-hg@20
    51
 * @param memory array of bytes / octets
franta-hg@20
    52
 * @param index offset in same units as memory type
franta-hg@20
    53
 * @param value value to be written at given position
franta-hg@20
    54
 */
franta-hg@20
    55
template<typename T> T write(octet_t * memory, address_t &index, const T value) {
franta-hg@20
    56
	if (index + sizeof (T) <= MEMORY_SIZE) {
franta-hg@20
    57
		T * m = reinterpret_cast<T*> (memory + index);
franta-hg@20
    58
		*m = value;
franta-hg@20
    59
		index += sizeof (value);
franta-hg@20
    60
	} else {
franta-hg@20
    61
		return logMemoryError<T>(index);
franta-hg@20
    62
	}
franta-hg@20
    63
}