pios_max7456.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see <http://www.gnu.org/licenses/>
 *
 * Additional note on redistribution: The copyright and license notices above
 * must be maintained in each individual source file that is a derivative work
 * of this source file; otherwise redistribution is prohibited.
 */

#ifndef LIB_MAX7456_MAX7456_H_
#define LIB_MAX7456_MAX7456_H_

#include <stdint.h>
#include <stdio.h>

#include <pios_spi.h>

#define MAX7456_MODE_PAL        0
#define MAX7456_MODE_NTSC       1

#define MAX7456_ATTR_NONE   0
#define MAX7456_ATTR_INVERT 1
#define MAX7456_ATTR_BLINK      2
#define MAX7456_ATTR_LBC        4

#define MAX7456_PAL_COLUMNS             30
#define MAX7456_PAL_ROWS                16
#define MAX7456_PAL_HCENTER             (MAX7456_PAL_COLUMNS / 2)
#define MAX7456_PAL_VCENTER             (MAX7456_PAL_ROWS / 2)

#define MAX7456_NTSC_COLUMNS    30
#define MAX7456_NTSC_ROWS               13
#define MAX7456_NTSC_HCENTER    (MAX7456_NTSC_COLUMNS / 2)
#define MAX7456_NTSC_VCENTER    (MAX7456_NTSC_ROWS / 2)

// NTSC and PAL have the same number of columns.
#define MAX7456_COLUMNS MAX7456_NTSC_COLUMNS
#define MAX7456_HCENTER MAX7456_NTSC_HCENTER

// Special formatting values
#define MAX7456_FMT_H_CENTER 31

typedef struct max7456_dev_s *max7456_dev_t;

void PIOS_MAX7456_wait_vsync ();

int PIOS_MAX7456_init (max7456_dev_t *dev_out,
                pios_spi_t spi_handle, uint32_t slave_idx);

void PIOS_MAX7456_clear (max7456_dev_t dev);

void PIOS_MAX7456_upload_char (max7456_dev_t dev, uint8_t char_index,
                const uint8_t *data);

void PIOS_MAX7456_download_char (max7456_dev_t dev,
                uint8_t char_index, uint8_t *data);

void PIOS_MAX7456_put (max7456_dev_t dev, uint8_t col, uint8_t row,
                uint8_t chr, uint8_t attr);

void PIOS_MAX7456_puts (max7456_dev_t dev, uint8_t col, uint8_t row,
                const char *s, uint8_t attr);

void PIOS_MAX7456_get_extents(max7456_dev_t dev, 
                uint8_t *mode, uint8_t *right, uint8_t *bottom,
                uint8_t *hcenter, uint8_t *vcenter);

void PIOS_MAX7456_wait_vsync(max7456_dev_t dev);

bool PIOS_MAX7456_stall_detect(max7456_dev_t dev);

void PIOS_MAX7456_set_mode(max7456_dev_t dev, bool force, uint8_t fallback);

#endif /* LIB_MAX7456_MAX7456_H_ */