URL
https://opencores.org/ocsvn/usb_dongle_fpga/usb_dongle_fpga/trunk
Subversion Repositories usb_dongle_fpga
Compare Revisions
- This comparison shows the changes necessary to convert path
/usb_dongle_fpga/trunk/src/design_top
- from Rev 49 to Rev 53
- ↔ Reverse comparison
Rev 49 → Rev 53
/design_top_thincandbg.vhd
0,0 → 1,545
------------------------------------------------------------------ |
-- Universal dongle board source code |
-- |
-- Copyright (C) 2006 Artec Design <jyrit@artecdesign.ee> |
-- |
-- This source code is free hardware; you can redistribute it and/or |
-- modify it under the terms of the GNU Lesser General Public |
-- License as published by the Free Software Foundation; either |
-- version 2.1 of the License, or (at your option) any later version. |
-- |
-- This source code 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 |
-- Lesser General Public License for more details. |
-- |
-- You should have received a copy of the GNU Lesser General Public |
-- License along with this library; if not, write to the Free Software |
-- Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
-- |
-- |
-- The complete text of the GNU Lesser General Public License can be found in |
-- the file 'lesser.txt'. |
|
|
|
-- Coding for seg_out(7:0) |
-- |
-- bit 0,A |
-- ---------- |
-- | | |
-- | | |
-- 5,F| | 1,B |
-- | 6,G | |
-- ---------- |
-- | | |
-- | | |
-- 4,E| | 2,C |
-- | 3,D | |
-- ---------- |
-- # 7,H |
|
-- Revision history |
-- |
-- Version 1.01 |
-- 15 oct 2006 version code 86 01 jyrit |
-- Added IO write to address 0x0088 with commands F1 and F4 to |
-- enable switching dongle to 4Meg mode for external reads |
-- Changed USB interface to address all 4 Meg on any mode jumper configuration |
-- |
-- Version 1.02 |
-- 04 dec 2006 version code 86 02 jyrit |
-- Added listen only mode for mode pin configuration "00" to enable post code |
-- spy mode (does not respond to external reads). |
|
|
library ieee; |
use ieee.std_logic_1164.all; |
use IEEE.std_logic_unsigned.all; |
use IEEE.std_logic_arith.all; |
|
entity design_top_thincandbg is |
port ( |
--system signals |
sys_clk : in std_logic; --25 MHz clk |
resetn : in std_logic; |
hdr : inout std_logic_vector(9 downto 0); |
--alt_clk : out std_logic; |
mode : in std_logic_vector(1 downto 0); --sel upper addr bits |
--lpc slave interf |
lad : inout std_logic_vector(3 downto 0); |
lframe_n : in std_logic; |
lreset_n : in std_logic; |
lclk : in std_logic; |
--led system |
seg_out : out std_logic_vector(7 downto 0); |
scn_seg : out std_logic_vector(3 downto 0); |
led_green : out std_logic; |
led_red : out std_logic; |
--flash interface |
fl_addr : out std_logic_vector(23 downto 0); |
fl_ce_n : out std_logic; --chip select |
fl_oe_n : out std_logic; --output enable for flash |
fl_we_n : out std_logic; --write enable |
fl_data : inout std_logic_vector(15 downto 0); |
fl_rp_n : out std_logic; --reset signal |
fl_sts : in std_logic; --status signal |
fl_sts_en : out std_logic; --enable status signal wiht highZ out |
--USB parallel interface |
usb_rd_n : inout std_logic; -- enables out data if low (next byte detected by edge / in usb chip) |
usb_wr : inout std_logic; -- write performed on edge \ of signal |
usb_txe_n : in std_logic; -- transmit enable (redy for new data if low) |
usb_rxf_n : in std_logic; -- rx fifo has data if low |
usb_bd : inout std_logic_vector(7 downto 0) --bus data |
); |
end design_top_thincandbg; |
|
|
|
architecture rtl of design_top_thincandbg is |
|
component led_sys --toplevel for led system |
generic( |
msn_hib : std_logic_vector(7 downto 0); --Most signif. of hi byte |
lsn_hib : std_logic_vector(7 downto 0); --Least signif. of hi byte |
msn_lob : std_logic_vector(7 downto 0); --Most signif. of hi byte |
lsn_lob : std_logic_vector(7 downto 0) --Least signif. of hi byte |
); |
port ( |
clk : in std_logic; |
reset_n : in std_logic; |
led_data_i : in std_logic_vector(15 downto 0); --binary data in |
seg_out : out std_logic_vector(7 downto 0); --one segment out |
sel_out : out std_logic_vector(3 downto 0) --segment scanner with one bit low |
); |
end component; |
|
|
component lpc_iow |
port ( |
--system signals |
lreset_n : in std_logic; |
lclk : in std_logic; |
lena_mem_r : in std_logic; --enable full adress range covering memory read block |
lena_reads : in std_logic; --enable read capabilities |
--LPC bus from host |
lad_i : in std_logic_vector(3 downto 0); |
lad_o : out std_logic_vector(3 downto 0); |
lad_oe : out std_logic; |
lframe_n : in std_logic; |
--memory interface |
lpc_addr : out std_logic_vector(23 downto 0); --shared address |
lpc_wr : out std_logic; --shared write not read |
lpc_data_i : in std_logic_vector(7 downto 0); |
lpc_data_o : out std_logic_vector(7 downto 0); |
lpc_val : out std_logic; |
lpc_ack : in std_logic |
); |
end component; |
|
|
component flash_if |
port ( |
clk : in std_logic; |
reset_n : in std_logic; |
--flash Bus |
fl_addr : out std_logic_vector(23 downto 0); |
fl_ce_n : out std_logic; --chip select |
fl_oe_n : out std_logic; --output enable for flash |
fl_we_n : out std_logic; --write enable |
fl_data : inout std_logic_vector(15 downto 0); |
fl_rp_n : out std_logic; --reset signal |
fl_byte_n : out std_logic; --hold in byte mode |
fl_sts : in std_logic; --status signal |
-- mem Bus |
mem_addr : in std_logic_vector(23 downto 0); |
mem_do : out std_logic_vector(15 downto 0); |
mem_di : in std_logic_vector(15 downto 0); |
mem_wr : in std_logic; --write not read signal |
mem_val : in std_logic; |
mem_ack : out std_logic |
); |
end component; |
|
|
component usb2mem |
port ( |
clk25 : in std_logic; |
reset_n : in std_logic; |
dongle_ver: in std_logic_vector(15 downto 0); |
-- mem Bus |
mem_busy_n: in std_logic; |
mem_idle : out std_logic; -- '1' if controller is idle (flash is safe for LPC reads) |
mem_addr : out std_logic_vector(23 downto 0); |
mem_do : out std_logic_vector(15 downto 0); |
mem_di : in std_logic_vector(15 downto 0); |
mem_wr : out std_logic; |
mem_val : out std_logic; |
mem_ack : in std_logic; |
mem_cmd : out std_logic; |
-- USB port |
usb_mode_en: in std_logic; -- enable this block |
usb_rd_n : out std_logic; -- enables out data if low (next byte detected by edge / in usb chip) |
usb_wr : out std_logic; -- write performed on edge \ of signal |
usb_txe_n : in std_logic; -- tx fifo empty (redy for new data if low) |
usb_rxf_n : in std_logic; -- rx fifo empty (data redy if low) |
usb_bd : inout std_logic_vector(7 downto 0) --bus data |
); |
end component; |
|
component pc_serializer |
Port ( --system signals |
sys_clk : in STD_LOGIC; |
resetn : in STD_LOGIC; |
--postcode data port |
dbg_data : in STD_LOGIC_VECTOR (7 downto 0); |
dbg_wr : in STD_LOGIC; --write not read |
dbg_full : out STD_LOGIC; --write not read |
dbg_almost_full : out STD_LOGIC; |
dbg_usedw : out STD_LOGIC_VECTOR (12 DOWNTO 0); |
--debug USB port |
dbg_usb_mode_en: in std_logic; -- enable this debug mode |
dbg_usb_wr : out std_logic; -- write performed on edge \ of signal |
dbg_usb_txe_n : in std_logic; -- tx fifo not full (redy for new data if low) |
dbg_usb_bd : inout std_logic_vector(7 downto 0) --bus data |
); |
end component; |
|
|
--LED signals |
signal data_to_disp : std_logic_vector(15 downto 0); |
--END LED SIGNALS |
|
--lpc signals |
signal lad_i : std_logic_vector(3 downto 0); |
signal lad_o : std_logic_vector(3 downto 0); |
signal lad_oe : std_logic; |
|
signal lpc_debug : std_logic_vector(31 downto 0); |
signal lpc_debug_cnt : std_logic_vector(15 downto 0); |
signal lpc_addr : std_logic_vector(23 downto 0); --shared address |
signal lpc_data_o : std_logic_vector(7 downto 0); |
signal lpc_data_i : std_logic_vector(7 downto 0); |
signal lpc_wr : std_logic; --shared write not read |
signal lpc_ack : std_logic; |
signal lpc_val : std_logic; |
signal lena_mem_r : std_logic; --enable full adress range covering memory read block |
signal lena_reads : std_logic; --enable/disables all read capabilty to make the device post code capturer |
|
signal c25_lpc_val : std_logic; |
signal c25_lpc_wr : std_logic; --shared write not read |
signal c25_lpc_wr_long : std_logic; --for led debug data latching |
|
signal c33_lpc_wr_long : std_logic; --for led debug data latching |
signal c33_lpc_wr : std_logic; --for led debug data latching |
signal c33_lpc_wr_wait: std_logic; --for led debug data latching |
signal c33_lpc_wr_waitd: std_logic; --for led debug data latching |
signal c33_wr_cnt : std_logic_vector(23 downto 0); --for led debug data latching |
|
|
--End lpc signals |
|
--Flash signals |
signal mem_addr : std_logic_vector(23 downto 0); |
signal mem_do : std_logic_vector(15 downto 0); |
signal mem_di : std_logic_vector(15 downto 0); |
signal mem_wr : std_logic; --write not read signal |
signal mem_val : std_logic; |
signal mem_ack : std_logic; |
|
signal c33_mem_ack : std_logic; --sync signal |
|
|
|
signal fl_ce_n_w : std_logic; --chip select |
signal fl_oe_n_w : std_logic; --output enable for flash |
|
--END flash signals |
|
--USB signals |
signal dbg_data : STD_LOGIC_VECTOR (7 downto 0); |
signal c25_dbg_addr_d : STD_LOGIC_VECTOR (7 downto 0); |
signal c33_dbg_addr_d : STD_LOGIC_VECTOR (7 downto 0); |
|
signal dbg_wr : STD_LOGIC; --write not read |
signal dbg_full : STD_LOGIC; --write not read |
signal dbg_almost_full : STD_LOGIC; |
signal dbg_usedw : STD_LOGIC_VECTOR (12 DOWNTO 0); |
|
signal force_4meg_n : std_logic; |
signal dbg_usb_mode_en : std_logic; |
signal usb_mode_en : std_logic; |
signal mem_idle : std_logic; |
signal umem_addr : std_logic_vector(23 downto 0); |
signal umem_do : std_logic_vector(15 downto 0); |
signal umem_wr : std_logic; |
signal umem_val : std_logic; |
signal umem_ack : std_logic; |
signal umem_cmd : std_logic; |
signal enable_4meg: std_logic; |
signal dongle_con_n : std_logic; |
|
constant dongle_ver : std_logic_vector(15 downto 0):=x"8606"; |
--END USB signals |
|
begin |
|
--GPIO PINS START |
fl_sts_en <='Z'; |
|
hdr(1) <= dongle_con_n; |
--hdr(1) <= fl_sts when resetn='1' else |
-- '0'; |
|
--when jumper on then mem read and firmware read enabled else only firmware read |
hdr(0) <= 'Z'; |
lena_mem_r <= not hdr(0); -- disabled if jumper is not on header pins 1-2 |
|
-- jumper on pins 5,6 then postcode only mode (no mem device) |
hdr(2) <= '0'; --create low pin for jumper pair 5-6 (this pin is 6 on J1 header) |
lena_reads <= hdr(3) and mem_idle and (not dongle_con_n); -- disabled if jumper is on (jumper makes it a postcode only device) paired with hdr(2) pins 5,6 and when usb control is not accessing flash |
|
|
-- when jumper on pins 7,8 then post code capture mode enabled |
hdr(4)<= '0'; |
dbg_usb_mode_en <= not hdr(5); --weak pullup on hdr(5) paired with hdr(4) |
usb_mode_en <= not dbg_usb_mode_en; |
|
-- when jumper on pins 9,10 then 4M window is forced |
hdr(6)<= '0'; |
force_4meg_n <= hdr(7); --weak pullup on hdr(7) paired with hdr(6) |
|
--GPIO PINS END |
|
--LED SUBSYSTEM START |
data_to_disp <= x"86"&lpc_debug(7 downto 0) when usb_mode_en='1' else --x"C0DE"; -- ASSIGN data to be displayed (should be regitered) |
"000"&dbg_usedw; --show tx fifo state on leds when postcode capture mode |
--########################################-- |
--VERSION CONSTATNS |
--########################################-- |
led_red <= enable_4meg; |
|
LEDS: led_sys --toplevel for led system |
generic map( |
msn_hib => "01111111",--8 --Most signif. of hi byte |
lsn_hib => "01111101",--6 --Least signif. of hi byte |
msn_lob => "10111111",--0 --Most signif. of hi byte This is version code |
--lsn_lob => "01001111" --3 --Least signif. of hi byte This is version code |
--lsn_lob => "01100110" --4 --Least signif. of hi byte This is version code |
--lsn_lob => "01101101" --5 --sync with dongle version const. Least signif. of hi byte This is version code |
lsn_lob => "01111101" --6 --sync with dongle version const. Least signif. of hi byte This is version code |
|
) |
port map( |
clk => sys_clk , -- in std_logic; |
reset_n => resetn, -- in std_logic; |
led_data_i => data_to_disp, -- in std_logic_vector(15 downto 0); --binary data in |
seg_out => seg_out, -- out std_logic_vector(7 downto 0); --one segment out |
sel_out => scn_seg -- out std_logic_vector(3 downto 0) --segment scanner with one bit low |
); |
|
--LED SUBSYSTEM END |
|
|
--MAIN DATAPATH CONNECTIONS |
--LPC bus logic |
lad_i <= lad; |
lad <= lad_o when lad_oe='1' else |
(others=>'Z'); |
|
--END LPC bus logic |
|
LPCBUS : lpc_iow |
port map( |
--system signals |
lreset_n => lreset_n, -- in std_logic; |
lclk => lclk, -- in std_logic; |
lena_mem_r => lena_mem_r, --: in std_logic; --enable full adress range covering memory read block |
lena_reads => lena_reads, -- : in std_logic; --enable read capabilities, : in std_logic; --enable read capabilities |
--LPC bus from host |
lad_i => lad_i, -- in std_logic_vector(3 downto 0); |
lad_o => lad_o, -- out std_logic_vector(3 downto 0); |
lad_oe => lad_oe, -- out std_logic; |
lframe_n => lframe_n, -- in std_logic; |
--memory interface |
lpc_addr => lpc_addr, -- out std_logic_vector(23 downto 0); --shared address |
lpc_wr => lpc_wr, -- out std_logic; --shared write not read |
lpc_data_i => lpc_data_i, -- in std_logic_vector(7 downto 0); |
lpc_data_o => lpc_data_o, -- out std_logic_vector(7 downto 0); |
lpc_val => lpc_val, -- out std_logic; |
lpc_ack => lpc_ack -- in std_logic |
); |
|
|
--memory data bus logic |
mem_addr <= mode&"11"&lpc_addr(19 downto 0) when c25_lpc_val='1' and enable_4meg='0' else --use mode bist |
mode&lpc_addr(21 downto 0) when c25_lpc_val='1' and enable_4meg='1' else --use mode bist |
mode&umem_addr(21 downto 0) when umem_val='1' else --use mode bist |
(others=>'Z'); |
|
mem_di <= (others=>'Z') when c25_lpc_val='1' else |
umem_do when umem_val='1' else |
(others=>'Z'); |
|
|
mem_wr <= c25_lpc_wr when c25_lpc_val='1' and c25_lpc_wr='0' else --pass read olny |
umem_wr when umem_val='1' else |
'0'; |
|
mem_val <= c25_lpc_val or umem_val; |
|
|
|
umem_ack <= mem_ack when umem_val='1' else |
'0'; |
|
|
lpc_data_i <= mem_do(7 downto 0) when lpc_addr(0)='0' else |
mem_do(15 downto 8); |
|
lpc_ack <= c33_mem_ack when lpc_val='1' and lpc_wr='0' else |
(not dbg_almost_full) when lpc_val='1' and lpc_wr='1' else |
'0'; |
|
|
|
SYNC1: process (lclk, lreset_n) --c33 |
begin |
if lclk'event and lclk = '1' then -- rising clock edge |
c33_mem_ack <= mem_ack; |
|
end if; |
end process SYNC1; |
|
|
dbg_data <= lpc_debug(7 downto 0); |
SYNC2: process (sys_clk) --c25 |
begin |
if sys_clk'event and sys_clk = '1' then -- rising clock edge |
c25_lpc_val <= lpc_val; --syncro two clock domains |
c25_lpc_wr <= c33_lpc_wr; --syncro two clock domains |
c25_dbg_addr_d <= c33_dbg_addr_d; --syncro two clock domains |
if usb_mode_en ='0' and c25_dbg_addr_d=x"80" then --don't fill fifo in regular mode |
dbg_wr<= c25_lpc_wr; --c33_lpc_wr_wait;--c33_lpc_wr_wait; |
else |
dbg_wr<='0'; --write never rises when usb_mode_en = 1 |
end if; |
end if; |
end process SYNC2; |
|
|
|
LATCHled: process (lclk,lreset_n) --c33 |
begin |
if lreset_n='0' then |
lpc_debug(7 downto 0)<=(others=>'0'); |
c33_dbg_addr_d <=(others=>'0'); |
enable_4meg <='0'; |
c33_lpc_wr <='0'; |
dongle_con_n <='0'; -- pin 3 in GPIO make it toggleable |
elsif lclk'event and lclk = '1' then -- rising clock edge |
c33_lpc_wr <= lpc_wr; |
if c33_lpc_wr='0' and lpc_wr='1' then |
c33_dbg_addr_d <= lpc_addr(7 downto 0); |
lpc_debug(7 downto 0)<= lpc_data_o; |
if lpc_addr(7 downto 0)=x"88" and lpc_data_o=x"F4" then --Flash 4 Mega enable (LSN is first MSN is second) |
enable_4meg <='1'; |
elsif lpc_addr(7 downto 0)=x"88" and lpc_data_o=x"F1" then --Flash 1 Mega enalbe |
enable_4meg <='0'; |
elsif lpc_addr(7 downto 0)=x"88" and lpc_data_o=x"D1" then --Set Dongle not attached signal |
dongle_con_n <='1'; -- pin 3 in GPIO make it 1 |
elsif lpc_addr(7 downto 0)=x"88" and lpc_data_o=x"D0" then --Set Dongle attached signal |
dongle_con_n <='0'; -- pin 3 in GPIO make it 1 |
end if; |
else |
if force_4meg_n='0' then -- active low (always force when jumper on) |
enable_4meg <='1'; |
end if; |
end if; |
end if; |
end process LATCHled; |
|
|
|
|
|
|
--END memory data bus logic |
fl_ce_n<= fl_ce_n_w; |
fl_oe_n<= fl_oe_n_w; |
|
FLASH : flash_if |
port map( |
clk => sys_clk, -- in std_logic; |
reset_n => resetn, -- in std_logic; |
--flash Bus |
fl_addr => fl_addr, -- out std_logic_vector(23 downto 0); |
fl_ce_n => fl_ce_n_w, -- out std_logic; --chip select |
fl_oe_n => fl_oe_n_w, -- buffer std_logic; --output enable for flash |
fl_we_n => fl_we_n, -- out std_logic; --write enable |
fl_data => fl_data, -- inout std_logic_vector(15 downto 0); |
fl_rp_n => fl_rp_n, -- out std_logic; --reset signal |
--fl_byte_n => fl_byte_n, -- out std_logic; --hold in byte mode |
fl_sts => fl_sts, -- in std_logic; --status signal |
-- mem Bus |
mem_addr => mem_addr, -- in std_logic_vector(23 downto 0); |
mem_do => mem_do, -- out std_logic_vector(15 downto 0); |
mem_di => mem_di, -- in std_logic_vector(15 downto 0); |
|
mem_wr => mem_wr, -- in std_logic; --write not read signal |
mem_val => mem_val, -- in std_logic; |
mem_ack => mem_ack -- out std_logic |
); |
|
|
|
USB: usb2mem |
port map( |
clk25 => sys_clk, -- in std_logic; |
reset_n => resetn, -- in std_logic; |
dongle_ver => dongle_ver, |
-- mem Bus |
mem_busy_n=> fl_sts, --check flash status before starting new command on flash |
mem_idle => mem_idle, |
mem_addr => umem_addr, -- out std_logic_vector(23 downto 0); |
mem_do => umem_do, -- out std_logic_vector(15 downto 0); |
mem_di => mem_do, -- in std_logic_vector(15 downto 0); --from flash |
mem_wr => umem_wr, -- out std_logic; |
mem_val => umem_val, -- out std_logic; |
mem_ack => umem_ack, -- in std_logic; --from flash |
mem_cmd => umem_cmd, -- out std_logic; |
-- USB port |
usb_mode_en => usb_mode_en, |
usb_rd_n => usb_rd_n, -- out std_logic; -- enables out data if low (next byte detected by edge / in usb chip) |
usb_wr => usb_wr, -- out std_logic; -- write performed on edge \ of signal |
usb_txe_n => usb_txe_n, -- in std_logic; -- tx fifo empty (redy for new data if low) |
usb_rxf_n => usb_rxf_n, -- in std_logic; -- rx fifo empty (data redy if low) |
usb_bd => usb_bd -- inout std_logic_vector(7 downto 0) --bus data |
); |
|
|
DBG : pc_serializer |
port map ( --system signals |
sys_clk => sys_clk, -- in STD_LOGIC; |
resetn => resetn, -- in STD_LOGIC; |
--postcode data port |
dbg_data => dbg_data, -- in STD_LOGIC_VECTOR (7 downto 0); |
dbg_wr => dbg_wr, -- in STD_LOGIC; --write not read |
dbg_full => dbg_full,--: out STD_LOGIC; --write not read |
dbg_almost_full => dbg_almost_full, |
dbg_usedw => dbg_usedw, |
|
--debug USB port |
dbg_usb_mode_en=> dbg_usb_mode_en, -- in std_logic; -- enable this debug mode |
dbg_usb_wr => usb_wr, -- out std_logic; -- write performed on edge \ of signal |
dbg_usb_txe_n => usb_txe_n, -- in std_logic; -- tx fifo not full (redy for new data if low) |
dbg_usb_bd => usb_bd -- inout std_logic_vector(7 downto 0) --bus data |
); |
|
|
--END MAIN DATAPATH CONNECTIONS |
|
end rtl; |
|
|
|
/Copyright.txt
0,0 → 1,22
------------------------------------------------------------------ |
-- Universal dongle board source code |
-- |
-- Copyright (C) 2006 Artec Design <jyrit@artecdesign.ee> |
-- |
-- This source code is free hardware; you can redistribute it and/or |
-- modify it under the terms of the GNU Lesser General Public |
-- License as published by the Free Software Foundation; either |
-- version 2.1 of the License, or (at your option) any later version. |
-- |
-- This source code 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 |
-- Lesser General Public License for more details. |
-- |
-- You should have received a copy of the GNU Lesser General Public |
-- License along with this library; if not, write to the Free Software |
-- Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
-- |
-- |
-- The complete text of the GNU Lesser General Public License can be found in |
-- the file 'lesser.txt'. |
/lesser.txt
0,0 → 1,504
GNU LESSER GENERAL PUBLIC LICENSE |
Version 2.1, February 1999 |
|
Copyright (C) 1991, 1999 Free Software Foundation, Inc. |
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
Everyone is permitted to copy and distribute verbatim copies |
of this license document, but changing it is not allowed. |
|
[This is the first released version of the Lesser GPL. It also counts |
as the successor of the GNU Library Public License, version 2, hence |
the version number 2.1.] |
|
Preamble |
|
The licenses for most software are designed to take away your |
freedom to share and change it. By contrast, the GNU General Public |
Licenses are intended to guarantee your freedom to share and change |
free software--to make sure the software is free for all its users. |
|
This license, the Lesser General Public License, applies to some |
specially designated software packages--typically libraries--of the |
Free Software Foundation and other authors who decide to use it. You |
can use it too, but we suggest you first think carefully about whether |
this license or the ordinary General Public License is the better |
strategy to use in any particular case, based on the explanations below. |
|
When we speak of free software, we are referring to freedom of use, |
not price. Our General Public Licenses are designed to make sure that |
you have the freedom to distribute copies of free software (and charge |
for this service if you wish); that you receive source code or can get |
it if you want it; that you can change the software and use pieces of |
it in new free programs; and that you are informed that you can do |
these things. |
|
To protect your rights, we need to make restrictions that forbid |
distributors to deny you these rights or to ask you to surrender these |
rights. These restrictions translate to certain responsibilities for |
you if you distribute copies of the library or if you modify it. |
|
For example, if you distribute copies of the library, whether gratis |
or for a fee, you must give the recipients all the rights that we gave |
you. You must make sure that they, too, receive or can get the source |
code. If you link other code with the library, you must provide |
complete object files to the recipients, so that they can relink them |
with the library after making changes to the library and recompiling |
it. And you must show them these terms so they know their rights. |
|
We protect your rights with a two-step method: (1) we copyright the |
library, and (2) we offer you this license, which gives you legal |
permission to copy, distribute and/or modify the library. |
|
To protect each distributor, we want to make it very clear that |
there is no warranty for the free library. Also, if the library is |
modified by someone else and passed on, the recipients should know |
that what they have is not the original version, so that the original |
author's reputation will not be affected by problems that might be |
introduced by others. |
|
Finally, software patents pose a constant threat to the existence of |
any free program. We wish to make sure that a company cannot |
effectively restrict the users of a free program by obtaining a |
restrictive license from a patent holder. Therefore, we insist that |
any patent license obtained for a version of the library must be |
consistent with the full freedom of use specified in this license. |
|
Most GNU software, including some libraries, is covered by the |
ordinary GNU General Public License. This license, the GNU Lesser |
General Public License, applies to certain designated libraries, and |
is quite different from the ordinary General Public License. We use |
this license for certain libraries in order to permit linking those |
libraries into non-free programs. |
|
When a program is linked with a library, whether statically or using |
a shared library, the combination of the two is legally speaking a |
combined work, a derivative of the original library. The ordinary |
General Public License therefore permits such linking only if the |
entire combination fits its criteria of freedom. The Lesser General |
Public License permits more lax criteria for linking other code with |
the library. |
|
We call this license the "Lesser" General Public License because it |
does Less to protect the user's freedom than the ordinary General |
Public License. It also provides other free software developers Less |
of an advantage over competing non-free programs. These disadvantages |
are the reason we use the ordinary General Public License for many |
libraries. However, the Lesser license provides advantages in certain |
special circumstances. |
|
For example, on rare occasions, there may be a special need to |
encourage the widest possible use of a certain library, so that it becomes |
a de-facto standard. To achieve this, non-free programs must be |
allowed to use the library. A more frequent case is that a free |
library does the same job as widely used non-free libraries. In this |
case, there is little to gain by limiting the free library to free |
software only, so we use the Lesser General Public License. |
|
In other cases, permission to use a particular library in non-free |
programs enables a greater number of people to use a large body of |
free software. For example, permission to use the GNU C Library in |
non-free programs enables many more people to use the whole GNU |
operating system, as well as its variant, the GNU/Linux operating |
system. |
|
Although the Lesser General Public License is Less protective of the |
users' freedom, it does ensure that the user of a program that is |
linked with the Library has the freedom and the wherewithal to run |
that program using a modified version of the Library. |
|
The precise terms and conditions for copying, distribution and |
modification follow. Pay close attention to the difference between a |
"work based on the library" and a "work that uses the library". The |
former contains code derived from the library, whereas the latter must |
be combined with the library in order to run. |
|
GNU LESSER GENERAL PUBLIC LICENSE |
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION |
|
0. This License Agreement applies to any software library or other |
program which contains a notice placed by the copyright holder or |
other authorized party saying it may be distributed under the terms of |
this Lesser General Public License (also called "this License"). |
Each licensee is addressed as "you". |
|
A "library" means a collection of software functions and/or data |
prepared so as to be conveniently linked with application programs |
(which use some of those functions and data) to form executables. |
|
The "Library", below, refers to any such software library or work |
which has been distributed under these terms. A "work based on the |
Library" means either the Library or any derivative work under |
copyright law: that is to say, a work containing the Library or a |
portion of it, either verbatim or with modifications and/or translated |
straightforwardly into another language. (Hereinafter, translation is |
included without limitation in the term "modification".) |
|
"Source code" for a work means the preferred form of the work for |
making modifications to it. For a library, complete source code means |
all the source code for all modules it contains, plus any associated |
interface definition files, plus the scripts used to control compilation |
and installation of the library. |
|
Activities other than copying, distribution and modification are not |
covered by this License; they are outside its scope. The act of |
running a program using the Library is not restricted, and output from |
such a program is covered only if its contents constitute a work based |
on the Library (independent of the use of the Library in a tool for |
writing it). Whether that is true depends on what the Library does |
and what the program that uses the Library does. |
|
1. You may copy and distribute verbatim copies of the Library's |
complete source code as you receive it, in any medium, provided that |
you conspicuously and appropriately publish on each copy an |
appropriate copyright notice and disclaimer of warranty; keep intact |
all the notices that refer to this License and to the absence of any |
warranty; and distribute a copy of this License along with the |
Library. |
|
You may charge a fee for the physical act of transferring a copy, |
and you may at your option offer warranty protection in exchange for a |
fee. |
|
2. You may modify your copy or copies of the Library or any portion |
of it, thus forming a work based on the Library, and copy and |
distribute such modifications or work under the terms of Section 1 |
above, provided that you also meet all of these conditions: |
|
a) The modified work must itself be a software library. |
|
b) You must cause the files modified to carry prominent notices |
stating that you changed the files and the date of any change. |
|
c) You must cause the whole of the work to be licensed at no |
charge to all third parties under the terms of this License. |
|
d) If a facility in the modified Library refers to a function or a |
table of data to be supplied by an application program that uses |
the facility, other than as an argument passed when the facility |
is invoked, then you must make a good faith effort to ensure that, |
in the event an application does not supply such function or |
table, the facility still operates, and performs whatever part of |
its purpose remains meaningful. |
|
(For example, a function in a library to compute square roots has |
a purpose that is entirely well-defined independent of the |
application. Therefore, Subsection 2d requires that any |
application-supplied function or table used by this function must |
be optional: if the application does not supply it, the square |
root function must still compute square roots.) |
|
These requirements apply to the modified work as a whole. If |
identifiable sections of that work are not derived from the Library, |
and can be reasonably considered independent and separate works in |
themselves, then this License, and its terms, do not apply to those |
sections when you distribute them as separate works. But when you |
distribute the same sections as part of a whole which is a work based |
on the Library, the distribution of the whole must be on the terms of |
this License, whose permissions for other licensees extend to the |
entire whole, and thus to each and every part regardless of who wrote |
it. |
|
Thus, it is not the intent of this section to claim rights or contest |
your rights to work written entirely by you; rather, the intent is to |
exercise the right to control the distribution of derivative or |
collective works based on the Library. |
|
In addition, mere aggregation of another work not based on the Library |
with the Library (or with a work based on the Library) on a volume of |
a storage or distribution medium does not bring the other work under |
the scope of this License. |
|
3. You may opt to apply the terms of the ordinary GNU General Public |
License instead of this License to a given copy of the Library. To do |
this, you must alter all the notices that refer to this License, so |
that they refer to the ordinary GNU General Public License, version 2, |
instead of to this License. (If a newer version than version 2 of the |
ordinary GNU General Public License has appeared, then you can specify |
that version instead if you wish.) Do not make any other change in |
these notices. |
|
Once this change is made in a given copy, it is irreversible for |
that copy, so the ordinary GNU General Public License applies to all |
subsequent copies and derivative works made from that copy. |
|
This option is useful when you wish to copy part of the code of |
the Library into a program that is not a library. |
|
4. You may copy and distribute the Library (or a portion or |
derivative of it, under Section 2) in object code or executable form |
under the terms of Sections 1 and 2 above provided that you accompany |
it with the complete corresponding machine-readable source code, which |
must be distributed under the terms of Sections 1 and 2 above on a |
medium customarily used for software interchange. |
|
If distribution of object code is made by offering access to copy |
from a designated place, then offering equivalent access to copy the |
source code from the same place satisfies the requirement to |
distribute the source code, even though third parties are not |
compelled to copy the source along with the object code. |
|
5. A program that contains no derivative of any portion of the |
Library, but is designed to work with the Library by being compiled or |
linked with it, is called a "work that uses the Library". Such a |
work, in isolation, is not a derivative work of the Library, and |
therefore falls outside the scope of this License. |
|
However, linking a "work that uses the Library" with the Library |
creates an executable that is a derivative of the Library (because it |
contains portions of the Library), rather than a "work that uses the |
library". The executable is therefore covered by this License. |
Section 6 states terms for distribution of such executables. |
|
When a "work that uses the Library" uses material from a header file |
that is part of the Library, the object code for the work may be a |
derivative work of the Library even though the source code is not. |
Whether this is true is especially significant if the work can be |
linked without the Library, or if the work is itself a library. The |
threshold for this to be true is not precisely defined by law. |
|
If such an object file uses only numerical parameters, data |
structure layouts and accessors, and small macros and small inline |
functions (ten lines or less in length), then the use of the object |
file is unrestricted, regardless of whether it is legally a derivative |
work. (Executables containing this object code plus portions of the |
Library will still fall under Section 6.) |
|
Otherwise, if the work is a derivative of the Library, you may |
distribute the object code for the work under the terms of Section 6. |
Any executables containing that work also fall under Section 6, |
whether or not they are linked directly with the Library itself. |
|
6. As an exception to the Sections above, you may also combine or |
link a "work that uses the Library" with the Library to produce a |
work containing portions of the Library, and distribute that work |
under terms of your choice, provided that the terms permit |
modification of the work for the customer's own use and reverse |
engineering for debugging such modifications. |
|
You must give prominent notice with each copy of the work that the |
Library is used in it and that the Library and its use are covered by |
this License. You must supply a copy of this License. If the work |
during execution displays copyright notices, you must include the |
copyright notice for the Library among them, as well as a reference |
directing the user to the copy of this License. Also, you must do one |
of these things: |
|
a) Accompany the work with the complete corresponding |
machine-readable source code for the Library including whatever |
changes were used in the work (which must be distributed under |
Sections 1 and 2 above); and, if the work is an executable linked |
with the Library, with the complete machine-readable "work that |
uses the Library", as object code and/or source code, so that the |
user can modify the Library and then relink to produce a modified |
executable containing the modified Library. (It is understood |
that the user who changes the contents of definitions files in the |
Library will not necessarily be able to recompile the application |
to use the modified definitions.) |
|
b) Use a suitable shared library mechanism for linking with the |
Library. A suitable mechanism is one that (1) uses at run time a |
copy of the library already present on the user's computer system, |
rather than copying library functions into the executable, and (2) |
will operate properly with a modified version of the library, if |
the user installs one, as long as the modified version is |
interface-compatible with the version that the work was made with. |
|
c) Accompany the work with a written offer, valid for at |
least three years, to give the same user the materials |
specified in Subsection 6a, above, for a charge no more |
than the cost of performing this distribution. |
|
d) If distribution of the work is made by offering access to copy |
from a designated place, offer equivalent access to copy the above |
specified materials from the same place. |
|
e) Verify that the user has already received a copy of these |
materials or that you have already sent this user a copy. |
|
For an executable, the required form of the "work that uses the |
Library" must include any data and utility programs needed for |
reproducing the executable from it. However, as a special exception, |
the materials to be distributed need not include anything that is |
normally distributed (in either source or binary form) with the major |
components (compiler, kernel, and so on) of the operating system on |
which the executable runs, unless that component itself accompanies |
the executable. |
|
It may happen that this requirement contradicts the license |
restrictions of other proprietary libraries that do not normally |
accompany the operating system. Such a contradiction means you cannot |
use both them and the Library together in an executable that you |
distribute. |
|
7. You may place library facilities that are a work based on the |
Library side-by-side in a single library together with other library |
facilities not covered by this License, and distribute such a combined |
library, provided that the separate distribution of the work based on |
the Library and of the other library facilities is otherwise |
permitted, and provided that you do these two things: |
|
a) Accompany the combined library with a copy of the same work |
based on the Library, uncombined with any other library |
facilities. This must be distributed under the terms of the |
Sections above. |
|
b) Give prominent notice with the combined library of the fact |
that part of it is a work based on the Library, and explaining |
where to find the accompanying uncombined form of the same work. |
|
8. You may not copy, modify, sublicense, link with, or distribute |
the Library except as expressly provided under this License. Any |
attempt otherwise to copy, modify, sublicense, link with, or |
distribute the Library is void, and will automatically terminate your |
rights under this License. However, parties who have received copies, |
or rights, from you under this License will not have their licenses |
terminated so long as such parties remain in full compliance. |
|
9. You are not required to accept this License, since you have not |
signed it. However, nothing else grants you permission to modify or |
distribute the Library or its derivative works. These actions are |
prohibited by law if you do not accept this License. Therefore, by |
modifying or distributing the Library (or any work based on the |
Library), you indicate your acceptance of this License to do so, and |
all its terms and conditions for copying, distributing or modifying |
the Library or works based on it. |
|
10. Each time you redistribute the Library (or any work based on the |
Library), the recipient automatically receives a license from the |
original licensor to copy, distribute, link with or modify the Library |
subject to these terms and conditions. You may not impose any further |
restrictions on the recipients' exercise of the rights granted herein. |
You are not responsible for enforcing compliance by third parties with |
this License. |
|
11. If, as a consequence of a court judgment or allegation of patent |
infringement or for any other reason (not limited to patent issues), |
conditions are imposed on you (whether by court order, agreement or |
otherwise) that contradict the conditions of this License, they do not |
excuse you from the conditions of this License. If you cannot |
distribute so as to satisfy simultaneously your obligations under this |
License and any other pertinent obligations, then as a consequence you |
may not distribute the Library at all. For example, if a patent |
license would not permit royalty-free redistribution of the Library by |
all those who receive copies directly or indirectly through you, then |
the only way you could satisfy both it and this License would be to |
refrain entirely from distribution of the Library. |
|
If any portion of this section is held invalid or unenforceable under any |
particular circumstance, the balance of the section is intended to apply, |
and the section as a whole is intended to apply in other circumstances. |
|
It is not the purpose of this section to induce you to infringe any |
patents or other property right claims or to contest validity of any |
such claims; this section has the sole purpose of protecting the |
integrity of the free software distribution system which is |
implemented by public license practices. Many people have made |
generous contributions to the wide range of software distributed |
through that system in reliance on consistent application of that |
system; it is up to the author/donor to decide if he or she is willing |
to distribute software through any other system and a licensee cannot |
impose that choice. |
|
This section is intended to make thoroughly clear what is believed to |
be a consequence of the rest of this License. |
|
12. If the distribution and/or use of the Library is restricted in |
certain countries either by patents or by copyrighted interfaces, the |
original copyright holder who places the Library under this License may add |
an explicit geographical distribution limitation excluding those countries, |
so that distribution is permitted only in or among countries not thus |
excluded. In such case, this License incorporates the limitation as if |
written in the body of this License. |
|
13. The Free Software Foundation may publish revised and/or new |
versions of the Lesser General Public License from time to time. |
Such new versions will be similar in spirit to the present version, |
but may differ in detail to address new problems or concerns. |
|
Each version is given a distinguishing version number. If the Library |
specifies a version number of this License which applies to it and |
"any later version", you have the option of following the terms and |
conditions either of that version or of any later version published by |
the Free Software Foundation. If the Library does not specify a |
license version number, you may choose any version ever published by |
the Free Software Foundation. |
|
14. If you wish to incorporate parts of the Library into other free |
programs whose distribution conditions are incompatible with these, |
write to the author to ask for permission. For software which is |
copyrighted by the Free Software Foundation, write to the Free |
Software Foundation; we sometimes make exceptions for this. Our |
decision will be guided by the two goals of preserving the free status |
of all derivatives of our free software and of promoting the sharing |
and reuse of software generally. |
|
NO WARRANTY |
|
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO |
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. |
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR |
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY |
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE |
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE |
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME |
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
|
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN |
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY |
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU |
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR |
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE |
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING |
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A |
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF |
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH |
DAMAGES. |
|
END OF TERMS AND CONDITIONS |
|
How to Apply These Terms to Your New Libraries |
|
If you develop a new library, and you want it to be of the greatest |
possible use to the public, we recommend making it free software that |
everyone can redistribute and change. You can do so by permitting |
redistribution under these terms (or, alternatively, under the terms of the |
ordinary General Public License). |
|
To apply these terms, attach the following notices to the library. It is |
safest to attach them to the start of each source file to most effectively |
convey the exclusion of warranty; and each file should have at least the |
"copyright" line and a pointer to where the full notice is found. |
|
<one line to give the library's name and a brief idea of what it does.> |
Copyright (C) <year> <name of author> |
|
This library is free software; you can redistribute it and/or |
modify it under the terms of the GNU Lesser General Public |
License as published by the Free Software Foundation; either |
version 2.1 of the License, or (at your option) any later version. |
|
This library 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 |
Lesser General Public License for more details. |
|
You should have received a copy of the GNU Lesser General Public |
License along with this library; if not, write to the Free Software |
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|
Also add information on how to contact you by electronic and paper mail. |
|
You should also get your employer (if you work as a programmer) or your |
school, if any, to sign a "copyright disclaimer" for the library, if |
necessary. Here is a sample; alter the names: |
|
Yoyodyne, Inc., hereby disclaims all copyright interest in the |
library `Frob' (a library for tweaking knobs) written by James Random Hacker. |
|
<signature of Ty Coon>, 1 April 1990 |
Ty Coon, President of Vice |
|
That's all there is to it! |
|
|