xfp: Decoder for XFP I2C structures

[libsigrokdecode.git] / decoders / xfp / __init__.py

diff --git a/decoders/xfp/__init__.py b/decoders/xfp/__init__.py
new file mode 100644 (file)
index 0000000..928fbc7
--- /dev/null
+++ b/decoders/xfp/__init__.py
@@ -0,0 +1,41 @@
+##
+## This file is part of the libsigrokdecode project.
+##
+## Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
+##
+## 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 2 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, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+'''
+XFP I2C management interface structure decoder.
+
+XFP modules include an I2C interface, used to monitor and control various
+aspects of the module. The specification defines an I2C slave at address
+0x50 (0xa0) which returns 128 bytes of a standard structure ("lower memory"),
+and, after setting a table number in lower memory, a set of 256 "higher
+memory" tables, which can be mapped to different subdevices on the XFP.
+
+Only one table is defined in the specification: table 0x01, the default on
+module startup. Other table are either reserved for future expansion, or
+available for vendor-specific extensions. This decoder supports both lower
+memory and table 0x01.
+
+The XFP specification is available here:
+
+  ftp://ftp.seagate.com/sff/INF-8077.PDF
+'''
+
+from .pd import *
+