libmmb103.h

/*
# This file is Copyright 2006, 2007, 2009 Dean Hall.
#
# This file is part of the Python-on-a-Chip program.
# Python-on-a-Chip is free software: you can redistribute it and/or modify
# it under the terms of the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1.
# 
# Python-on-a-Chip 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.
# A copy of the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1
# is seen in the file COPYING up one directory from this.
*/


#ifndef __LIBMMB103_H__
#define __LIBMMB103_H__


/*
 * MMB103 Library Header
 */


#define MMB103_v1j 1       
#define MMB103_v1m 2       
#define MMB103_VER MMB103_v1m

#define DIG_LATCH (*(volatile uint8_t *)0xB800)

#define DIP_LATCH (*(volatile uint8_t *)0xA800)

#define BAUD_2400 103
#define BAUD_4800 51
#define BAUD_9600 25
#define BAUD_14400 16
#define BAUD_19200 12
#define BAUD_28800 8
#define BAUD_38400 6
#define BAUD_57600 3
#define BAUD_76800 2
#define BAUD_115200 1

#define ADC_STOP            0
#define ADC_CK_DIV_2        (_BV(ADPS0))
#define ADC_CK_DIV_4        (_BV(ADPS1))
#define ADC_CK_DIV_8        (_BV(ADPS1) | _BV(ADPS0))
#define ADC_CK_DIV_16       (_BV(ADPS2))
#define ADC_CK_DIV_32       (_BV(ADPS2) | _BV(ADPS0))
#define ADC_CK_DIV_64       (_BV(ADPS2) | _BV(ADPS1))
#define ADC_CK_DIV_128      (_BV(ADPS2) | _BV(ADPS1) | _BV(ADPS0)) /* 2Ksps */

#define PWM_STOP            0
#define PWM_CK_DIV_1        _BV(CS10)                /* 15 KHz */
#define PWM_CK_DIV_8        _BV(CS11)                /* 2 KHz  */
#define PWM_CK_DIV_64       (_BV(CS11) | _BV(CS10))   /* 244 Hz */
#define PWM_CK_DIV_256      _BV(CS12)
#define PWM_CK_DIV_1024     (_BV(CS12) | _BV(CS10))


#define MIN(a,b) (((a) < (b)) ? (a) : (b))
#define MAX(a,b) (((a) > (b)) ? (a) : (b))

/* LCD ctl pins, grouped by fxn */
#define LCD_CLS             0x01
#define LCD_HOME            0x02
/* entry mode set */
#define LCD_ENTRY           0x04
#define LCD_ENTRY_CURS_INCR 0x02
#define LCD_ENTRY_DISP_SHFT 0x01
/* display ctl */
#define LCD_DISP            0x08
#define LCD_DISP_DISP_ON    0x04
#define LCD_DISP_CURS_BLOCK 0x03
#define LCD_DISP_CURS_ULINE 0x02
#define LCD_DISP_CURS_BLINK 0x01
/* cursor/display shift */
#define LCD_CURS            0x10
#define LCD_CURS_DISP_SHFT  0x08
#define LCD_CURS_SHFT_R     0x04
/* function set */
#define LCD_FUNC            0x20
#define LCD_FUNC_8B_DATA    0x10
#define LCD_FUNC_MULTI_LINE 0x08
#define LCD_FUNC_FONT_5x10  0x04    /* no effect */
/* set CGRAM addr */
#define LCD_CGRAM(n)        (0x40 + ((n) << 3))
/* set DDRAM addr */
/* these might not work for 4 line displays */
#define LCD_CURSOR(n)       (0x80 + ((n) & 0x7f))
#define LCD_LINE(n)         LCD_CURSOR(((n) & 0x02) ? 0x20 : 0x00 \
                                       + ((n) & 0x01) ? 0x40 : 0x00)
/* LCD mini-macros */
#define LCD_ENTRY_DECR      (LCD_ENTRY)
#define LCD_ENTRY_INCR      (LCD_ENTRY | LCD_ENTRY_CURS_INCR)
#define LCD_DISP_OFF        (LCD_DISP)
#define LCD_DISP_ON         (LCD_DISP | LCD_DISP_DISP_ON)
#define LCD_CURS_ULINE      (LCD_DISP | LCD_DISP_DISP_ON | LCD_DISP_CURS_ULINE)
#define LCD_CURS_BLOCK      (LCD_DISP | LCD_DISP_DISP_ON | LCD_DISP_CURS_BLOCK)
#define LCD_CURS_BLINK      /*TBD*/
#define LCD_CURS_LEFT       (LCD_CURS)
#define LCD_CURS_RIGHT      (LCD_CURS | LCD_CURS_SHFT_R)
#define LCD_DISP_LEFT       (LCD_CURS | LCD_CURS_DISP_SHFT)
#define LCD_DISP_RIGHT      (LCD_CURS | LCD_CURS_DISP_SHFT | LCD_CURS_SHFT_R)
#define LCD_MODE_MULTILINE  (LCD_FUNC | LCD_FUNC_8B_DATA | LCD_FUNC_MULTI_LINE)


void mmb_init(uint8_t uart_rate,
              uint8_t adc_rate,
              uint8_t pwm_rate,
              uint8_t num_lcd_lines,
              uint8_t num_lcd_cols);

uint8_t mmb_adc_get(uint8_t ch);

#define mmb_dig_get(p) (uint8_t)((DIG_LATCH & _BV(p)) ? 1 : 0)

#define mmb_dig_get_byte() (DIG_LATCH)

#define mmb_dip_get(p) (uint8_t)((DIP_LATCH & _BV(p)) ? 1 : 0)

#define mmb_dip_get_byte() (DIP_LATCH)

void mmb_spi_init(uint8_t spi_rate);

uint8_t mmb_spiGetByte(void);

void mmb_spiPutByte(uint8_t c);

uint8_t mmb_spiGetByteN(uint8_t *p, uint8_t n);

void mmb_spiPutByteN(uint8_t *p, uint8_t n);

void mmb_lcd_clr_scr(void);


void mmb_lcd_set_cursor(uint8_t line, uint8_t col);


void mmb_lcd_print_char(uint8_t ch);

void mmb_lcd_print_str(char *s);

void mmb_lcd_print_hex8(uint8_t v8);

void mmb_lcd_print_hex16(uint16_t v16);

void mmb_lcd_put_ctl(uint8_t val);

void mmb_lcd_title_screen(void);

void mmb_set_mota_pwm(int16_t dc_10bit);

void mmb_set_motb_pwm(int16_t dc_10bit);

void mmb_motc_init(void);

void mmb_set_motc_pwm(uint8_t dc_8b);

void mmb_beep(int16_t freq, int16_t ms);

void mmb_servo_init(uint8_t enable);

void mmb_set_servo_a(int8_t pos);

void mmb_set_servo_b(int8_t pos);

#endif /* __LIBMMB103_H__ */