i2c.h

Go to the documentation of this file.

//i2c.h:
 
/*
 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2012-2013
 *
 *  This file is part of aroarfw, a RoarAudio framework for
 *  embedded systems (µControlers).
 *
 *  This file is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 3
 *  or (at your option) any later version as published by
 *  the Free Software Foundation.
 *
 *  aroarfw 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 software; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 */
 
#ifndef _AROARFW_I2C_H_
#define _AROARFW_I2C_H_
 
#include <stdint.h>
#include <aroarfw/types.h>
 
#define I2C_OFFSET_IFVERSION          0x00
#define I2C_OFFSET_STATUS0            0x01
#define I2C_OFFSET_BANKSELECT         0x02
#define I2C_OFFSET_DEVERROR           0x03
#define I2C_OFFSET_BANKDATA           0x04
 
#define RI2C_INTERFACE_VERSION        0x00
 
#define RI2C_STATUS0_NONE             0x00
#define RI2C_STATUS0_DEVICE_READY     0x01
#define RI2C_STATUS0_SELFCHECK_PASSED 0x02
#define RI2C_STATUS0_SELFCHECK_ERROR  0x04
#define RI2C_STATUS0_UPDATES_PENDING  0x08
 
#define RI2C_STATUS1_NONE             0x00
#define RI2C_STATUS2_NONE             0x00
 
#define RI2C_CAPS0_BRIDGE_NONE        0x00
#define RI2C_CAPS0_BRIDGE_NETWORK     0x01
#define RI2C_CAPS0_BRIDGE_ETHERNET    0x02
#define RI2C_CAPS0_BRIDGE_I2C         0x04
#define RI2C_CAPS0_BRIDGE_SPI         0x08
#define RI2C_CAPS0_BRIDGE_DMX512      0x10
#define RI2C_CAPS0_BRIDGE_MIDI        0x20
#define RI2C_CAPS0_BRIDGE_WAVEFORM    0x40
#define RI2C_CAPS0_BRIDGE_RESERVED7   0x80
 
typedef uint8_t ri2c_addr_t;
 
typedef enum {
 RI2C_DEV_GENERIC            = 0x00,
 
// 1-63: RAF Defined types
 RI2C_DEV_BRIDGE             = 0x01,
 
//$ for i in `seq 64 127`; do v=`expr $i - 64`; printf " //! Vendor specific device type %i\n RI2C_DEV_VENDOR%.2i           = %#0.2x,\n" $v $v $i; done
 RI2C_DEV_VENDOR00           = 0x40,
 RI2C_DEV_VENDOR01           = 0x41,
 RI2C_DEV_VENDOR02           = 0x42,
 RI2C_DEV_VENDOR03           = 0x43,
 RI2C_DEV_VENDOR04           = 0x44,
 RI2C_DEV_VENDOR05           = 0x45,
 RI2C_DEV_VENDOR06           = 0x46,
 RI2C_DEV_VENDOR07           = 0x47,
 RI2C_DEV_VENDOR08           = 0x48,
 RI2C_DEV_VENDOR09           = 0x49,
 RI2C_DEV_VENDOR10           = 0x4a,
 RI2C_DEV_VENDOR11           = 0x4b,
 RI2C_DEV_VENDOR12           = 0x4c,
 RI2C_DEV_VENDOR13           = 0x4d,
 RI2C_DEV_VENDOR14           = 0x4e,
 RI2C_DEV_VENDOR15           = 0x4f,
 RI2C_DEV_VENDOR16           = 0x50,
 RI2C_DEV_VENDOR17           = 0x51,
 RI2C_DEV_VENDOR18           = 0x52,
 RI2C_DEV_VENDOR19           = 0x53,
 RI2C_DEV_VENDOR20           = 0x54,
 RI2C_DEV_VENDOR21           = 0x55,
 RI2C_DEV_VENDOR22           = 0x56,
 RI2C_DEV_VENDOR23           = 0x57,
 RI2C_DEV_VENDOR24           = 0x58,
 RI2C_DEV_VENDOR25           = 0x59,
 RI2C_DEV_VENDOR26           = 0x5a,
 RI2C_DEV_VENDOR27           = 0x5b,
 RI2C_DEV_VENDOR28           = 0x5c,
 RI2C_DEV_VENDOR29           = 0x5d,
 RI2C_DEV_VENDOR30           = 0x5e,
 RI2C_DEV_VENDOR31           = 0x5f,
 RI2C_DEV_VENDOR32           = 0x60,
 RI2C_DEV_VENDOR33           = 0x61,
 RI2C_DEV_VENDOR34           = 0x62,
 RI2C_DEV_VENDOR35           = 0x63,
 RI2C_DEV_VENDOR36           = 0x64,
 RI2C_DEV_VENDOR37           = 0x65,
 RI2C_DEV_VENDOR38           = 0x66,
 RI2C_DEV_VENDOR39           = 0x67,
 RI2C_DEV_VENDOR40           = 0x68,
 RI2C_DEV_VENDOR41           = 0x69,
 RI2C_DEV_VENDOR42           = 0x6a,
 RI2C_DEV_VENDOR43           = 0x6b,
 RI2C_DEV_VENDOR44           = 0x6c,
 RI2C_DEV_VENDOR45           = 0x6d,
 RI2C_DEV_VENDOR46           = 0x6e,
 RI2C_DEV_VENDOR47           = 0x6f,
 RI2C_DEV_VENDOR48           = 0x70,
 RI2C_DEV_VENDOR49           = 0x71,
 RI2C_DEV_VENDOR50           = 0x72,
 RI2C_DEV_VENDOR51           = 0x73,
 RI2C_DEV_VENDOR52           = 0x74,
 RI2C_DEV_VENDOR53           = 0x75,
 RI2C_DEV_VENDOR54           = 0x76,
 RI2C_DEV_VENDOR55           = 0x77,
 RI2C_DEV_VENDOR56           = 0x78,
 RI2C_DEV_VENDOR57           = 0x79,
 RI2C_DEV_VENDOR58           = 0x7a,
 RI2C_DEV_VENDOR59           = 0x7b,
 RI2C_DEV_VENDOR60           = 0x7c,
 RI2C_DEV_VENDOR61           = 0x7d,
 RI2C_DEV_VENDOR62           = 0x7e,
 RI2C_DEV_VENDOR63           = 0x7f
} ri2c_dev_t;
 
typedef enum {
 RI2C_SUBTYPE_BRIDGE_GENERIC            = 0x00,
 RI2C_SUBTYPE_BRIDGE_CONVERTER          = 0x01
} ri2c_subtype_bridge_t;
 
typedef enum {
// 0-31: Generic
 RI2C_BANK_DEVINFO           = 0x00,
 RI2C_BANK_SYSCTL            = 0x01,
 RI2C_BANK_GPDIO             = 0x02,
 RI2C_BANK_GPAIO             = 0x03,
// 32-63: RAF Defined
 
// DISPLAY interface?
 RI2C_BANK_DMX512            = 0x3f,
 
// 64-95: RAF Defined Type/Sub-Type specific
 
//$ for i in `seq 64 95`; do v=`expr $i - 64`; printf " //! Assigned Type and Subtype specific bank %i\n RI2C_BANK_TYPEST%.2i          = %#0.2x,\n" $v $v $i; done
 RI2C_BANK_TYPEST00          = 0x40,
 RI2C_BANK_TYPEST01          = 0x41,
 RI2C_BANK_TYPEST02          = 0x42,
 RI2C_BANK_TYPEST03          = 0x43,
 RI2C_BANK_TYPEST04          = 0x44,
 RI2C_BANK_TYPEST05          = 0x45,
 RI2C_BANK_TYPEST06          = 0x46,
 RI2C_BANK_TYPEST07          = 0x47,
 RI2C_BANK_TYPEST08          = 0x48,
 RI2C_BANK_TYPEST09          = 0x49,
 RI2C_BANK_TYPEST10          = 0x4a,
 RI2C_BANK_TYPEST11          = 0x4b,
 RI2C_BANK_TYPEST12          = 0x4c,
 RI2C_BANK_TYPEST13          = 0x4d,
 RI2C_BANK_TYPEST14          = 0x4e,
 RI2C_BANK_TYPEST15          = 0x4f,
 RI2C_BANK_TYPEST16          = 0x50,
 RI2C_BANK_TYPEST17          = 0x51,
 RI2C_BANK_TYPEST18          = 0x52,
 RI2C_BANK_TYPEST19          = 0x53,
 RI2C_BANK_TYPEST20          = 0x54,
 RI2C_BANK_TYPEST21          = 0x55,
 RI2C_BANK_TYPEST22          = 0x56,
 RI2C_BANK_TYPEST23          = 0x57,
 RI2C_BANK_TYPEST24          = 0x58,
 RI2C_BANK_TYPEST25          = 0x59,
 RI2C_BANK_TYPEST26          = 0x5a,
 RI2C_BANK_TYPEST27          = 0x5b,
 RI2C_BANK_TYPEST28          = 0x5c,
 RI2C_BANK_TYPEST29          = 0x5d,
 RI2C_BANK_TYPEST30          = 0x5e,
 RI2C_BANK_TYPEST31          = 0x5f,
 
// 96-127: Vendor + Type/Sub-Type specific
//$ for i in `seq 96 127`; do v=`expr $i - 96`; printf " //! Vendor, Type and Subtype specific bank %i\n RI2C_BANK_VENDOR%.2i          = %#0.2x,\n" $v $v $i; done
 RI2C_BANK_VENDOR00          = 0x60,
 RI2C_BANK_VENDOR01          = 0x61,
 RI2C_BANK_VENDOR02          = 0x62,
 RI2C_BANK_VENDOR03          = 0x63,
 RI2C_BANK_VENDOR04          = 0x64,
 RI2C_BANK_VENDOR05          = 0x65,
 RI2C_BANK_VENDOR06          = 0x66,
 RI2C_BANK_VENDOR07          = 0x67,
 RI2C_BANK_VENDOR08          = 0x68,
 RI2C_BANK_VENDOR09          = 0x69,
 RI2C_BANK_VENDOR10          = 0x6a,
 RI2C_BANK_VENDOR11          = 0x6b,
 RI2C_BANK_VENDOR12          = 0x6c,
 RI2C_BANK_VENDOR13          = 0x6d,
 RI2C_BANK_VENDOR14          = 0x6e,
 RI2C_BANK_VENDOR15          = 0x6f,
 RI2C_BANK_VENDOR16          = 0x70,
 RI2C_BANK_VENDOR17          = 0x71,
 RI2C_BANK_VENDOR18          = 0x72,
 RI2C_BANK_VENDOR19          = 0x73,
 RI2C_BANK_VENDOR20          = 0x74,
 RI2C_BANK_VENDOR21          = 0x75,
 RI2C_BANK_VENDOR22          = 0x76,
 RI2C_BANK_VENDOR23          = 0x77,
 RI2C_BANK_VENDOR24          = 0x78,
 RI2C_BANK_VENDOR25          = 0x79,
 RI2C_BANK_VENDOR26          = 0x7a,
 RI2C_BANK_VENDOR27          = 0x7b,
 RI2C_BANK_VENDOR28          = 0x7c,
 RI2C_BANK_VENDOR29          = 0x7d,
 RI2C_BANK_VENDOR30          = 0x7e,
 RI2C_BANK_VENDOR31          = 0x7f
} ri2c_bank_t;
 
typedef struct {
 uint8_t vendor;
 uint8_t type;
 uint8_t subtype;
 uint8_t revision;
 uint8_t parentvendor;
 uint8_t parenttype;
 uint8_t parentsubtype;
 uint8_t caps[3];
 ruuid_t serial;
} __RPACKED__ ri2c_devinfo_data_t;
 
#endif
 
//ll