packages/web/353/php_top/i2c.php

Go to the documentation of this file.

<?php
/*!***************************************************************************
*! FILE NAME  : i2c.php
*! DESCRIPTION: Provides single byte/short r/w from/to the i2c
*!              Setting per-slave protection mask,
*!              Synchronizing system clock with a "CMOS" one
*!              Reading from/writing to EEPROM memory
*! Copyright (C) 2008 Elphel, Inc
*! -----------------------------------------------------------------------------**
*!
*!  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/>.
*! -----------------------------------------------------------------------------**
*!  $Log: i2c.php,v $
*!  Revision 1.10  2008/07/16 23:18:54  spectr_rain
*!  option cmd=readCMOS - just read w/o modification of camera time
*!
*!  Revision 1.8  2008/04/24 20:32:44  elphel
*!  reverted, wrong edit
*!
*!  Revision 1.7  2008/04/24 18:19:50  elphel
*!  changed to absolute path to i2c.inc
*!
*!  Revision 1.6  2008/03/16 01:24:09  elphel
*!  Added i2c speed control interface
*!
*!  Revision 1.5  2008/03/15 23:05:18  elphel
*!  split i2c.php into i2c.php and i2c.inc (to be used from other scripts)
*!
*!  Revision 1.4  2008/03/15 18:38:21  elphel
*!  Implemented add-on boards EEPROM support
*!
*!  Revision 1.3  2008/02/20 07:41:42  elphel
*!  report error if the date is wrong
*!
*!  Revision 1.2  2008/02/13 00:30:01  elphel
*!  Added system time synchronization  with "CMOS" clock
*!
*!  Revision 1.1  2008/02/12 21:53:20  elphel
*!  Modified I2c to support multiple buses, added raw access (no address registers) and per-slave protection bitmasks
*!
*!
*/

require 'i2c.inc';

  $width=0;
  $bus=0;
  $adr=-1;
  $data="";
  $nopars=false;
  $raw=0;
  $wprot=-1;
  $rprot=-1;
  $rslt="";
  $cmd="";
//
  $model="";
  $rev="";
  $brand="Elphel";
  $serial="";
  $time="";
  $msg="<?xml version=\"1.0\"?>\n<i2c>\n";
  if (count($_GET) == 0 ) {
     $nopars=true;
   } else {
     $pars=array();
     foreach($_GET as $key=>$value) {
       switch($key) {
       case "cmd":
         switch($value) {
         case "fromCMOS":
          $rslt=i2c_getCMOSClock()?"Set system time error (probably CMOS clock is not set)":("System clock is set to ".exec("date"));
          break;
         case "readCMOS":
          $rslt=i2c_readCMOSClock()?"Read CMOS clock error (probably CMOS clock is not set)":("CMOS clock is ".exec("date"));
          break;
         case "toCMOS":
          $rslt=i2c_setCMOSClock();
          break;
         case "fromEEPROM":
         case "toEEPROM":
         case "ctl":
          $cmd=$value;
          break;
         }
       break;
       case "model":
          $model=$value;
          break;
       case "rev":
          $rev=$value;
          break;
       case "serial":
          $serial=$value;
          break;
       case "time": // seconds from 1970
          $time=$value+0;
          break;
       case "raw":
          $adr=($value+0) & ~0x7f;
          $raw=1;
          $width=8;
          break;
       case "width":
          $width=$value+0;
          break;
       case "bus":
          $bus=$value+0;
          break;
       case "adr":
          $adr=$value+0;
          break;
       case "wp":
          if      ($value==0) $wprot=0;
          else if ($value==1) $wprot=1;
          break;
       case "rp":
          if      ($value==0) $rprot=0;
          else if ($value==1) $rprot=1;
          break;
       case "data":
          $data=$value;
          break;
       }
     }
   }

   switch($cmd) {
      case "fromEEPROM":
        $rslt=i2c_read256b();
        $zero=strpos($rslt,chr(0));
        if ($zero!==false) $rslt=substr($rslt,0, $zero);
        if (substr($rslt,0,5)=="<?xml") {
                  // make encoding as URL-encoding (i.e. in "%decimal_value" format)
          header("Content-Type: text/xml");
          header("Content-Length: ".strlen($rslt)."\n");
          header("Pragma: no-cache\n");
          printf($rslt);
          exit (0);
        }
                $rslt=bin2hex($rslt);

        break;
      case "toEEPROM":
        if ($wprot>=0) {
          i2c_setprot (1,0xa0,1,(1-$wprot));
        }
        if ($data=="") {
          if ($model  === "") {$rslt="model  not specified"; break;}
          if ($rev    === "") {$rslt="rev    not specified"; break;}
          if ($serial === "") {$rslt="serial not specified"; break;}
          if ($time   === "") {$rslt="time   not specified"; break;}
           $xml = new SimpleXMLElement("<?xml version='1.0' standalone='yes'?><board/>");
           $xml->addChild ('brand',$brand);
           $xml->addChild ('model',$model);
           $xml->addChild ('rev',  $rev);
           $xml->addChild ('serial',$serial);
           $xml->addChild ('time',$time);
           $data=$xml->asXML();
        }
        if (strlen($data)>256) {
           $rslt="data too long - ".strlen($data)." bytes, only 256 are permitted";
           break;
        }
        $rslt="written ".i2c_write256b($data);
        i2c_setprot (1,0xa0,1,0);
        break;
      case "ctl":
        if ($bus=="") {
         $rslt="i2c bus number is not specified";
         break;
        }
        $rslt=i2c_ctl($bus,$data)->asXML();
        header("Content-Type: text/xml");
        header("Content-Length: ".strlen($rslt)."\n");
        header("Pragma: no-cache\n");
        printf($rslt);
        exit (0);
    }
   if ($rslt=="") {
    if (($adr>=0) && (($width==8) || ($width==16))) {
      $slave=($adr >> (($width==16)?8:7)) & 0xfe;
      if ($wprot>=0) {
       i2c_setprot ($bus,$slave,1,(1-$wprot));
      }
      if ($rprot>=0) {
       i2c_setprot ($bus,$slave,0,(1-$rprot));
      }
      $msg.="<width>".$width."</width>\n";
      $msg.="<bus>".$bus."</bus>\n";
      $msg.="<slave>".(sprintf("0x%x",($adr>>(($width==8)?7:8))  & 0xfe ))."</slave>\n";

      if (!$raw) {
        $msg.="<adr>".$adr."</adr>\n";
        $msg.="<hex_adr>".sprintf("0x%x",$adr)."</hex_adr>\n";
      }
     if ($data!="") { 
      $data+=0;
      $msg.="<data>".$data."</data>\n";
      $msg.="<wdata>".$data."</wdata>\n";
      $msg.="<hex_data>".sprintf("0x%x",$data)."</hex_data>\n";
      $rslt=i2c_send($width,$bus,$adr,$data,$raw);
      if (!($rslt>0)) $msg.="<error> \"i2c write error (".$rslt.")\"</error>\n";
     } else { 
      $data=i2c_receive($width,$bus,$adr,$raw);
      $msg.="<data>".$data."</data>\n";
      $msg.="<rdata>".$data."</rdata>\n";
      $msg.="<hex_data>".sprintf("0x%x",$data)."</hex_data>\n";
      if ($data==-1) $msg.="<error> \"i2c read error\"</error>\n";
     }
    } else {
     if (!$nopars) $msg.="<error>\"Address (adr or raw) or width are not specified or are not positive.\"</error>\n";
     $msg.="<usage>\"open URL: i2c.php?width&#061;www&amp;bus&#061;bbb&amp;adr&#061;aaa&amp;data&#061;ddd\"</usage>\n";
    }
   } else {
      $msg.="<result>\"".$rslt."\"</result>\n";
   }

   $msg.="</i2c>\n";
   header("Content-Type: text/xml");
   header("Content-Length: ".strlen($msg)."\n");
   header("Pragma: no-cache\n");
   printf($msg);
?>

---