decoders/xfp/__init__.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 2 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 '''
  21 This PD decodes the XFP I²C management interface structures/protocol.
  22
  23 XFP modules include an I²C interface, used to monitor and control various
  24 aspects of the module. The specification defines an I²C slave at address
  25 0x50 (0xa0) which returns 128 bytes of a standard structure ("lower memory"),
  26 and, after setting a table number in lower memory, a set of 256 "higher
  27 memory" tables, which can be mapped to different subdevices on the XFP.
  28
  29 Only one table is defined in the specification: table 0x01, the default on
  30 module startup. Other table are either reserved for future expansion, or
  31 available for vendor-specific extensions. This decoder supports both lower
  32 memory and table 0x01.
  33
  34 The XFP specification is available here:
  35
  36   ftp://ftp.seagate.com/sff/INF-8077.PDF
  37 '''
  38
  39 from .pd import Decoder