' ****************************************************************
' * File:  uk_gmb_i2c.pbas  -  Ver. 1.1                          *
' * Compiler:  mikroBasic for PIC by mikroElektronica            *
' * IDE: mikroBasic for PIC by mikroElektronica                  *
' * Compiler Version: 1.1.5.0                                    *
' * Boards: GMM 4620 + GMB HR168                                 *
' *   GRIFO(R)   via Dell'Artigiano 8/6                          *
' *   40016 S. Giorgio di Piano (BO)                             *
' *   Tel. +39 051 892052                   Fax. +39 051 893661  *
' *   http://www.grifo.com                  http://www.grifo.it  *
' * by Graziano Gaiba                              11.02.05      *
' ****************************************************************
'
' This Demo allows to communicate to I2C BUS devices connected to
' CN8. It is possible to read or write bytes at any slave address
' and location address input by console.
' In detail, when reading the byte read is visualized and when
' writing the byte input is sent.
'
' Rel 1.1 - by Graziano Gaiba
' Demo program of generic I2C BUS communication using a GMB HR168
' driven by Mini Module GMM 4620
'
'
' ******************** Compiler definitions **********************
'
program uk_gmb_i2c
'
' ******************* Constants declaration **********************
'
const RTCSLA = $A0
'
' ******************** Variables declaration *********************
'
' Generic variables
dim i as byte
dim scelta as byte
dim di as byte
dim s as string[2]
'
' Used by I2C BUS hardware management
dim i2c_buffer as byte[10]
dim i2c_to_send as byte
dim i2c_to_receive as byte
dim i2c_val as byte
dim i2c_data as byte
dim i2c_slave as byte
dim i2c_addr as byte
dim i2c_cnt as byte
'
'
' **************** Procedures definition ******************
'
'
' CPU and signals directions initialization
sub procedure Init_cpu
    ADCON1=$0f        ' Imposta come I/O digitale i pin AN0..12
    CMCON=$07         ' Imposta come I/O digitale RA0..4
' Optocoupled Inputs of CN1 are:
' IN1-1 <-> RA0
' IN2-1 <-> RA1
' IN3-1 <-> RB0
' IN4-1 <-> RB1
' IN5-1 <-> RA4
' IN6-1 <-> RC0
' IN7-1 <-> RC1
' IN8-1 <-> RC5
    trisa.0=1
    trisa.1=1
    trisa.4=1
    trisb.0=1
    trisb.1=1
    trisc.0=1
    trisc.1=1
    trisc.5=1
' Optocoupled Inputs of CN2 are:
' IN1-2 <-> RD0
' IN2-2 <-> RD1
' IN3-2 <-> RD2
' IN4-2 <-> RD3
' IN5-2 <-> RD4
' IN6-2 <-> RD5
' IN7-2 <-> RD6
' IN8-2 <-> RD7
    trisd=$ff
' Relay outputs of CN3 are:
' OUT A1 <-> RB4
' OUT A2 <-> RB5
' OUT B1 <-> RB6
' OUT B2 <-> RB7
' OUT C1 <-> RB3
' OUT C2 <-> RB2
    trisb=trisb and $03
' Relay outputs of CN4 are:
' OUT D1 <-> RA3
' OUT D2 <-> RC2 (J10 in position 3-4)
    trisa.3=0
    trisc.2=0
    ' Initialize module USART (8 bit, 19200 baud rate,
    ' no parity)
    Usart_init(19200)
end sub      '
' Send a string of characters to the serial port
sub procedure print_USART(dim byref txt as char[255])
    dim i as byte
    dim l as byte

    l = txt[0]
    for i = 1 to l
        USART_Write(txt[i])
    next i
end sub
'
' Send CR + LF
sub procedure print_CRLF
    USART_Write(10)
    USART_Write(13)
end sub
'
'
' Clear screen, sending 25 times CR + LF.
sub procedure clrscr
    for i = 0 to 24
    print_CRLF
    next i
end sub
'
'
' Asks for a key press
sub procedure wait_key
    dim c as byte
    
    print_usart("Press a key...")
    do
        nop
    loop until USART_Data_Ready = 1
    c = USART_Read
end sub
'
'
' Procedure to set the status of the relays on connectors CN3 and CN4.
' According to the bits of port_val, each relay is turned ON
' (contact closed) or OFF (contact open).
' Bits of port_val have this meanging:
' -- CN3
' port_val.0 drives relay OUT A1
' port_val.1 drives relay OUT A2
' port_val.2 drives relay OUT B1
' port_val.3 drives relay OUT B2
' port_val.4 drives relay OUT C1
' port_val.5 drives relay OUT C2
' -- CN4
' port_val.6 drives relay OUT D1
' port_val.7 drives relay OUT D2
'
' Each bit has the following meaning:
'   bit              Meaning
'    0    Relay turned OFF (contact open)
'    1    Relay turned ON (contact closed)
sub procedure set_relays(dim port_val as byte)
' Relays are driven in complemented logic, so port_val must be
' complemented too
    port_val=port_val xor $ff
    portb.4=port_val.0
    portb.5=port_val.1
    portb.6=port_val.2
    portb.7=port_val.3
    portb.3=port_val.4
    portb.2=port_val.5

    porta.3=port_val.6

    portc.2=port_val.7
end sub
'
'
' Initialize I2C BUS hardware
sub procedure I2CBUSInit
'
' Initialize  I2C BUS
' Configure RC3 and RC4 as inputs
    trisc.3=1
    trisc.4=1
' Enable SSP module in master I2C BUS mode, clock 50 kHz
    sspstat.6=0
    sspadd=$32
    sspcon1=$28
end sub
'                    
'
' Generate I2C BUS start
sub procedure I2CBUSStart
    sspcon2.0=1
    while sspcon2.0=1
    wend
    pir1.3=0
end sub
'
'
' Generate I2C BUS repeated start
sub procedure I2CBUSRepStart
    sspcon2.1=1
    while sspcon2.1=1
    wend
    pir1.3=0
end sub
'
'
' Generate I2C BUS stop
sub procedure I2CBUSStop
    sspcon2.2=1
    while sspcon2.2=1
    wend
    pir1.3=0
end sub
' 
'
' Send content of variable i2c_data to I2C BUS
sub procedure I2CBUSSend(dim i2c_data as byte)
    sspbuf=i2c_data
' Wait for last operation of hardware I2C interface to complete
    while pir1.3=0
    wend
    pir1.3=0
end sub
' 
'
' Read a data from I2C BUS and end subs it
sub function I2CBUSGet as byte
    sspcon2.3=1
    while sspcon2.3=1
    wend
    result=sspbuf
' Wait for last operation of hardware I2C interface to complete
    while pir1.3=0
    wend
    pir1.3=0
end sub
'
'
' Send NOT acknowledge
sub procedure I2CBUSNACK
' Send NOT acknowledge...
    sspcon2.5=1
    sspcon2.4=1
' Wait for last operation of hardware I2C interface to complete
    while pir1.3=0
    wend
    pir1.3=0
end sub
'
'
' Send acknowledge
sub procedure I2CBUSACK
' Send acknowledge...
    sspcon2.5=0
    sspcon2.4=1
' Wait for last operation of hardware I2C interface to complete
    while pir1.3=0
    wend
    pir1.3=0
end sub
'
'
' Indicates that an expected acknowledge has not been received.
sub procedure I2CBUSNotAck
    print_USART("Acknowledge not received.")
    print_crlf
' Disables I2CBUS
    sspcon1.5=0
end sub

'
'
' Read one byte from device whose slave address is indicated in variable
' i2c_slave and whose address is specified in variable i2c_addr.
' Data read is returned.
sub function I2CBUSReadByte(dim i2c_slave as byte, dim i2c_addr as byte) as byte
'
' Generates I2CBUS Start.
    i2cbusstart
' Send Slave Address
    i2cbussend(i2c_slave)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
' Send address
    i2cbussend(i2c_addr)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
' Generates repeated I2CBUS Start.
    i2cbusrepstart
' Send Slave Address for reading
    i2cbussend(i2c_slave or $01)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
' Get data
    result = i2cbusget
' Send NOT acknowledge.
    I2CBUSNACK
' Generate stop
    i2cbusstop
end sub
'
'
' Write one byte to device whose slave address is indicated in variable
' i2c_slave and whose address is specified in variable i2c_addr.
' Data to write must be in variable i2c_data.
sub procedure I2CBUSWriteByte(dim i2c_slave as byte, dim i2c_addr as byte,
                              dim i2c_data as byte)
'
' Generates I2CBUS Start.
    i2cbusstart
' Send Slave Address for writing
    i2cbussend(i2c_slave)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
' Send address
    i2cbussend(i2c_addr)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
' Send data
    i2cbussend(i2c_val)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
' Generates stop
    i2cbusstop
end sub
'
'
' Send a sequence of bytes to I2C BUS device.
' Slave address must be in variable i2c_slave.
' Data to send must be in array i2c_buffer. User may change its size by
' changing the definition of array i2c_buffer.
' Number of bytes to send must be in variable i2c_to_send. User must check
' for overflows.
sub procedure I2CBUSWrite(dim i2c_slave as byte,
                          dim byref i2c_buffer as byte[10],
                          dim i2c_to_send as byte)
'
' Generates I2CBUS Start.
    i2cbusstart
' Send Slave Address for writing
    i2cbussend(i2c_slave)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
    for i2c_cnt=0 to i2c_to_send - 1
' Send data
        i2cbussend(i2c_buffer[i2c_cnt])
' If acknowledge not received, signal an error
        if sspcon2.6=1 then I2CBUSNotAck
        end if
    next i2c_cnt
' Generate stop
    i2cbusstop
end sub
'
'
' Send a sequence of bytes then read a sequence of byte from I2C BUS device.
' Slave address must be in variable i2c_slave.
' Data to send must be in array i2c_buffer. User may change its size by
' changing the definition of array i2c_buffer.
' Data will be received in the abovce mentioned array.
' Number of bytes to send must be in variable i2c_to_send. User must check
' for overflows.
' Number of bytes to receive must be in variable i2c_to_receive. User must
' check for overflows.
sub procedure I2CBUSRead(dim i2c_slave as byte,
                         dim byref i2c_buffer as byte[10],
                         dim i2c_to_send as byte,
                         dim i2c_to_receive as byte)
'
' Generates I2CBUS Start.
    i2cbusstart
' Send Slave Address for writing
    i2cbussend(i2c_slave)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
    for i2c_cnt=0 to i2c_to_send - 1
' Send data
        i2cbussend(i2c_buffer[i2c_cnt])
' If acknowledge not received, signal an error
        if sspcon2.6=1 then I2CBUSNotAck
        end if
    next i2c_cnt
' Generate repeated I2CBUS Start.
    i2cbusrepstart
' Send Slave Address for reading
    i2cbussend(i2c_slave or $01)
' If acknowledge not received, signal an error
    if sspcon2.6=1 then I2CBUSNotAck
    end if
    for i2c_cnt=0 to i2c_to_receive - 1
' Read data
        i2c_buffer[i2c_cnt] = i2cbusget
        if i2c_cnt = i2c_to_receive - 1 then
' Send NOT acknowledge.
            I2CBUSNACK
        else
' Send acknowledge.
            I2CBUSaCK
        end if
    next i2c_cnt
' Invia lo stop
    i2cbusstop
end sub
'
' Check if the input parameter is an hexadecimal digit.
sub function is_HEX_digit(dim v as byte) as byte
    dim flag as byte

    flag = 0
    if (v >=48) and (v <= 57) then
        flag = 1
    end if
    if (v >= 65) and (v <= 70) then
        flag = 1
    end if
    if (v >= 97) and (v <= 102) then
        flag = 1
    end if

    Result = flag
end sub
'
'
' Returns the value of a single hexadecimal digit.
' Does NOT check if input parameter is an hexadecimal digit.
sub function HEX_val(dim v as byte) as byte
    v = v - 48
    if v > 9 then
        v = v - 17
        if v > 5 then
            v = v - 32
        end if
        v = v + 10
    end if

    Result = v
end sub
'
'
' Inputs an hexadecimal vale of up to four digits.
' Input parameter is number of digits, it returns an interger
' containing the value input by te user.
' It can manage backspace (ASCII 08) and accepts digits from
' '0' to '9', from 'a' to 'f' and from 'A' to 'F'.
' It sends a bell character (ASCII 07) when receives a character
' not acceptable for input, or user tries to input or delete out
' of possible range.
sub function inputHEX(dim n_char as byte) as word
    dim str_input as byte[6]
    dim idx as byte
    dim chr_input as byte
    dim pow_of_16 as word[5]
    dim value as word

    pow_of_16[1] = 1
    pow_of_16[2] = 16
    pow_of_16[3] = 256
    pow_of_16[4] = 4096
    ' Index must start from 1
    idx = 1
    Inc(n_char)
    ' No character in input
    chr_input = 0
    ' Starting value
    value = 0
    ' Loop until CR is received
    while chr_input <> 13
        ' If a data is ready
        if usart_data_ready = 1 then
            ' Read it
            chr_input = USART_Read
            ' If backspace (ASCII BS)
            if chr_input = 8 then
                ' and buffer is not empty
                if idx > 1 then
                    ' Send data read
                    USART_Write(chr_input)
                    ' Delete character
                    USART_Write(32)
                    USART_Write(chr_input)
                    ' delete last input data
                    Dec(idx)
                else
                    ' Bell to indicate an error
                    USART_Write(7)
                end if
            end if
            ' If CR received, elaborate the value and return it
            if chr_input = 13 then
                n_char = 0
                while idx > 1
                    Dec(idx)
                    Inc(n_char)
                    value = value + HEX_val(str_input[n_char]) * pow_of_16[idx]
                wend
            else
                ' If character can be input
                if idx < n_char then
                    ' If data received is in valid range:
                    ' 0..9 or 'a'..'f' or 'A'..'F'
                    if is_HEX_digit(chr_input) = 1 then
                        ' Send data read
                        USART_Write(chr_input)
                        ' Store it in input buffer
                        str_input[idx] = chr_input
                        ' Point to next position
                        Inc(idx)
                    end if
                else
                    ' Bell to indicate an error
                    USART_Write(7)
                end if
            end if
        end if
    wend
    print_CRLF
    Result = value
end sub
'
'************************** Main Program *******************************
'
main:
    Init_cpu
' Turn OFF relays
    set_relays(0)
' Initialize hardware I2C BUS peripheral
    i2cbusinit
for_ever:
    clrscr
    print_USART("Demo I2C BUS Rel 1.1 for GMM 4620 rel 120304 and GMB HR168 rel 110104")
    print_crlf
    print_crlf
    print_USART("1) Send")
    print_crlf
    print_USART("2) Receive")
    print_crlf
    print_crlf
    di = 0
    do
        print_USART("Choice: ")
        scelta = inputHEX(1)
    loop until (scelta > 0) and (scelta < 3)
    print_crlf
    print_crlf
    print_USART("Enter slave address in hexadecimal: ")
    i2c_slave = inputHEX(2)
    print_CRLF
    print_USART("How many data to send (0 to 9)? ")
    i2c_to_send = inputHEX(1)
    for i=1 to i2c_to_send
        print_USART("Please input (hexadecimal) data n. ")
        ByteToStr(i, s)
        print_USART(s)
        print_USART(": ")
        i2c_buffer[i - 1] = inputHEX(2)
    next i
if scelta = 1 then
    i2cbuswrite(i2c_slave, i2c_buffer, i2c_to_send)
else
    print_USART("How many data to receive (0 to 9)? ")
    i2c_to_receive = inputHEX(1)
    i2cbusread(i2c_slave, i2c_buffer, i2c_to_send, i2c_to_receive)
    print_CRLF
for i=1 to i2c_to_receive
     print_USART("Received data n.")
     ByteToStr(i, s)
     print_USART(s)
     print_USART(": ")
     ByteToStr(i2c_buffer[i - 1], s)
     print_USART(s)
     print_CRLF
next i
end if
    print_CRLF
    wait_key

goto for_ever
end.