summaryrefslogtreecommitdiffstats
path: root/kernel/Documentation/devicetree/bindings/i2c/i2c-mxs.txt
blob: 4e1c8ac01eba54da7685cbbaf69109e1ff69634a (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

* Freescale MXS Inter IC (I2C) Controller

Required properties:
- compatible: Should be "fsl,<chip>-i2c"
- reg: Should contain registers location and length
- interrupts: Should contain ERROR interrupt number
- clock-frequency: Desired I2C bus clock frequency in Hz.
                   Only 100000Hz and 400000Hz modes are supported.
- dmas: DMA specifier, consisting of a phandle to DMA controller node
  and I2C DMA channel ID.
  Refer to dma.txt and fsl-mxs-dma.txt for details.
- dma-names: Must be "rx-tx".

Examples:

i2c0: i2c@80058000 {
	#address-cells = <1>;
	#size-cells = <0>;
	compatible = "fsl,imx28-i2c";
	reg = <0x80058000 2000>;
	interrupts = <111>;
	clock-frequency = <100000>;
	dmas = <&dma_apbx 6>;
	dma-names = "rx-tx";
};
000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ } 
=========================================================================================
OPNFV Release Note for the Arno SR1 release of OPNFV when using Fuel as a deployment tool
=========================================================================================


.. contents:: Table of Contents
   :backlinks: none


Abstract
========

This document compiles the release notes for the Arno SR1 release of
OPNFV when using Fuel as a deployment tool.

License
=======

Arno SR1 release with the Fuel deployment tool Docs (c) by Jonas
Bjurel (Ericsson AB)

Arno SR1 release with the Fuel deployment tool Docs are licensed under
a Creative Commons Attribution 4.0 International License. You should
have received a copy of the license along with this. If not, see
<http://creativecommons.org/licenses/by/4.0/>.


Version history
===============

+--------------------+--------------------+--------------------+--------------------+
| **Date**           | **Ver.**           | **Author**         | **Comment**        |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+
| 2015-06-03         | 1.0.0              | Jonas Bjurel       | Arno SR0 release   |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+
| 2015-09-28         | 1.1.3              | Jonas Bjurel       | Arno SR1 release   |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+

Important notes
===============

For the first OPNFV release (Arno), these notes introduce use of
`OpenStack Fuel <https://wiki.openstack.org/wiki/Fuel>` for the
deployment stage of the OPNFV continuous integration (CI) pipeline.
The goal of the Arno release and this Fuel-based deployment process is
to establish a foundational platform accelerating further development
of the OPNFV infrastructure.


Carefully follow the installation-instructions and pay special
attention to the pre-deploy script that needs to be run before
deployment is started.


Summary
=======

For Arno SR1, the typical use of Fuel as an OpenStack installer is
supplemented with OPNFV unique components such as `OpenDaylight
<http://www.opendaylight.org/software>`_ version Helium as well as
OPNFV-unique configurations.


This Arno artefact provides Fuel as the deployment stage tool in the
OPNFV CI pipeline including:


- Documentation built by Jenkins
  - this document (release notes)
  - installation instructions
  - build-instructions
- The Arno Fuel installer image (.iso) built by Jenkins
- Automated deployment of Arno with running on bare metal or a nested
  hypervisor environment (KVM)
- Automated validation of the Arno deployment


Release Data
============

+--------------------------------------+--------------------------------------+
| **Project**                          | genesis/bgs                          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | genesis/arno.2015.2.0                |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Arno Base Service release 1 (SR1)    |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | 2015-10-01                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV Arno Base SR1 release          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Version change
--------------

Module version changes
~~~~~~~~~~~~~~~~~~~~~~
This is the second tracked release of genesis/fuel. It is based on
following upstream versions:

- Fuel 6.1.0
- OpenStack Juno release
- OpenDaylight Litium release

Document version changes
~~~~~~~~~~~~~~~~~~~~~~~~
This is the second tracked version of the fuel installer for OPNFV. It
comes with the following documentation:

- OPNFV Installation instructions for Arno with Fuel as deployment tool
- OPNFV Release Notes for Arno use of Fuel as deployment tool
- OPNFV Build instructions for Arno with Fuel as deployment tool


Reason for version
------------------
Feature additions
~~~~~~~~~~~~~~~~~

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: FUEL-4                         | Baselining Fuel 6.0.1 for OPNFV      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: FUEL-17                        | Integration of OpenDaylight          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Bug corrections
~~~~~~~~~~~~~~~

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: BGS-57                         | The OpenDaylight Helium release is   |
|                                      | not fully functional and the         |
|                                      | resulting Fuel integration is not    |
|                                      | able to cope with the deficiancies.  |
|                                      | It is therefore not recommended to   |
|                                      | to enable this option.               |
|                                      | A functional integration of ODL      |
|                                      | version: Lithium is expected to be   |
|                                      | available in an upcomming service    |
|                                      | release.                             |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Deliverables
------------

Software deliverables
~~~~~~~~~~~~~~~~~~~~~
Fuel-based installer iso file <arno.2015.2.0.fuel.iso>

Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
- OPNFV Installation instructions for Arno release with the Fuel
  deployment tool - ver. 1.1.0
- OPNFV Build instructions for Arno release with the Fuel deployment
  tool - ver. 1.1.0
- OPNFV Release Note for Arno release with the Fuel deployment tool -
  ver. 1.1.3 (this document)

Known Limitations, Issues and Workarounds
=========================================

System Limitations
------------------

**Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades

**Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade

**Storage:**    Ceph is the only supported storage configuration.

**Max number of networks:**   3800 (Needs special switch config.)


Known issues
------------

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| JIRA: FUEL-43                        | VMs not accessible through SSH due   |
|                                      | to VXLAN 50 Byte overhead and lack   |
|                                      | of proper MTU value setting on       |
|                                      | virtual ethernet devices             |
+--------------------------------------+--------------------------------------+
| JIRA: FUEL-44                        | Centos 6.5 option has not been       |
|                                      | enough verified                      |
+--------------------------------------+--------------------------------------+


Workarounds
-----------
See JIRA: `FUEL-43 <https://jira.opnfv.org/browse/FUEL-43>`


Test Result
===========
Arno SR1 release with the Fuel deployment tool has undergone QA test
runs with the following results:
https://wiki.opnfv.org/arno_sr1_result_page?rev=1443626728

References
==========
For more information on the OPNFV Arno release, please see
http://wiki.opnfv.org/releases/arno.

:Authors: Jonas Bjurel (Ericsson)
:Version: 1.1.3

**Documentation tracking**

Revision: _sha1_

Build date:  _date_