spi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, 2024, 2025 Adrian "asie" Siekierka
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#ifndef NILE_SPI_H_
#define NILE_SPI_H_
 
#include <wonderful.h>
#include "hardware.h"
 
#ifndef __ASSEMBLER__
#include <stdbool.h>
#include <stdint.h>

uint16_t nile_spi_get_timeout(void);

void nile_spi_set_timeout(uint16_t ms);

bool nile_spi_wait_ready(void);

bool nile_spi_abort(void);
 
typedef enum {
    NILE_SPI_SPEED_384KHZ = 0x00, 
    NILE_SPI_SPEED_6MHZ = 0x01, 
    NILE_SPI_SPEED_24MHZ = 0x02 
} nile_spi_speed_t;

bool nile_spi_set_speed(nile_spi_speed_t speed);

bool nile_spi_set_device(uint16_t device);

bool nile_spi_set_control(uint16_t value);

static inline void nile_spi_flip_buffer(void) {
    outportb(IO_NILE_SPI_CNT + 1, inportb(IO_NILE_SPI_CNT + 1) ^ (NILE_SPI_BUFFER_IDX >> 8));
}

bool nile_spi_rx_async(uint16_t size, uint16_t mode);

static inline bool nile_spi_tx_async(uint16_t size) {
    return nile_spi_rx_async(size, NILE_SPI_MODE_WRITE);
}

bool nile_spi_tx_async_block(const void __far* buf, uint16_t size);

static inline bool nile_spi_tx_sync_block(const void __far* buf, uint16_t size) {
    return nile_spi_tx_async_block(buf, size) && nile_spi_wait_ready();
}

bool nile_spi_rx_sync_flip(uint16_t size, uint16_t mode);

bool nile_spi_rx_sync_block(void __far* buf, uint16_t size, uint16_t mode);

bool nile_spi_xch_block(void __far* buf, uint16_t size);

uint16_t nile_spi_xch(uint8_t value);
#define NILE_SPI_XCH_ERROR_MASK 0xFF00
 
#endif /* __ASSEMBLER__ */
 
#endif /* NILE_SPI_H_ */