diff --git a/Data/Stdf.hs b/Data/Stdf.hs new file mode 100644 --- /dev/null +++ b/Data/Stdf.hs @@ -0,0 +1,198 @@ + +{-# LANGUAGE NegativeLiterals #-} +{-# LANGUAGE DeriveGeneric #-} + +module Data.Stdf ( parse + , Stdf(..) + , Rec(..) + ) where + +import Data.Binary.Get +import Data.ByteString.Lazy.Char8 as BL hiding (show) +import Data.Word +import Data.Int +import Data.Bits (testBit) +import Foreign.C.Types +import Control.Applicative +import Prelude hiding (show) +import Text.Show +import Control.Monad +import Data.Text.Lazy +import qualified Data.ByteString.Base64.Lazy as Base64 +import Data.Text.Lazy.Encoding + +import GHC.Generics hiding (U1) +import Data.Aeson + +-- JSON gotcha: can't encode ByteString +-- Have to convert character strings to Text-latin1 +-- Encoding base64 raw binary data + +-- I was thinking of supporting the CPU_TYPE for converting numbers +-- with different endianness then I realized I would have to support +-- different floating-point encodings from old Sun and DEC architectures +-- and I was like fuck that. All my testers and all my computers are x86 +-- anyway. + +type U1 = Word8 -- unsigned 1 byte +type U2 = Word16 -- unsigned 2 bytes +type U4 = Word32 -- unsigned 4 bytes +type I1 = Int8 +type I2 = Int16 +type I4 = Int32 +type R4 = CFloat +type R8 = CDouble + +instance ToJSON Rec +instance ToJSON PartFlg + +data BinRec = BinRec + { header :: Header + , rec :: Rec } deriving (Generic, Show) + +data Header = Header + { len :: !Word16 + , typ :: !Word8 + , sub :: !Word8 + } deriving (Generic, Show) + +type Stdf = [Rec] + +data Rec = Raw { raw :: Text } -- base64 TODO: maybe don't bother. what's this good for? + | Far { cpuType :: !U1 + , stdfVer :: !U1 } + | Prr { headNum :: !U1 + , siteNum :: !U1 + , partFlg :: !PartFlg + , numTest :: !U2 + , hardBin :: !U2 + , softBin :: Maybe U2 + , xCoord :: Maybe I2 + , yCoord :: Maybe I2 + , testTime :: Maybe U4 + , partID :: Maybe Text + , partTxt :: Maybe Text + , partFix :: Maybe Text } + deriving (Generic, Show) + +data PartFlg = PartFlg { supersedesPartId :: Bool -- 1 bit + , supersedesXY :: Bool -- 1 bit + , abnormalEnd :: Bool + , failed :: Bool + , noPassFailInfo :: Bool } + deriving (Generic, Show) + +getFar :: Get Rec +getFar = Far <$> getWord8 <*> getWord8 + +u1 = getWord8 +u2 = getWord16le +u4 = getWord32le +cn = getVarLen + +i1 :: Get I1 +i1 = fromIntegral <$> u1 + +i2 :: Get I2 +i2 = fromIntegral <$> u2 + +i4 :: Get I1 +i4 = fromIntegral <$> u1 + +mu2 :: Get (Maybe U2) +mu2 = missing (65535 :: U2) <$> u2 + +missing :: Eq a => a -> a -> Maybe a +missing n m = + if m == n + then Nothing + else Just m + + +mi2 :: Get (Maybe I2) +mi2 = do + x <- i2 + return $ case x of + (-32768) -> Nothing + otherwise -> Just x + +mu4 :: Get (Maybe U4) +mu4 = do + x <- u4 + return $ case x of + 0 -> Nothing + otherwise -> Just x + +getVarLen :: Get (Maybe Text) +getVarLen = do + len <- u1 + case len of + 0 -> return Nothing + otherwise -> liftM (Just . decodeUtf8) $ getLazyByteString (fromIntegral len) + +bit :: U1 -> Int -> Bool +bit = testBit + +getPartFlg :: Get PartFlg +getPartFlg = do + b <- u1 + return PartFlg { supersedesPartId = bit b 0 + , supersedesXY = bit b 1 + , abnormalEnd = bit b 2 + , failed = bit b 3 + , noPassFailInfo = bit b 4 } + +getPrr :: Get Rec +getPrr = Prr <$> u1 <*> u1 <*> getPartFlg <*> u2 <*> u2 <*> mu2 <*> mi2 <*> mi2 <*> mu4 <*> cn <*> cn <*> cn + +getRawRec :: Integral a => a -> Get Rec +getRawRec len = do + bytes <- getLazyByteString (fromIntegral len) + return Raw { raw = (decodeUtf8 . Base64.encode) bytes } + +-- First get the 'len' number of bytes +-- Although you could just parse the stream directly you would be +-- disapointed when a buggy STDF had some fields of the wrong width +-- in records you didn't even care about and you lose the ability +-- to read the rest of the stream forever +getRec :: Header -> Get Rec +getRec hdr = do + record <- getLazyByteString (fromIntegral $ len hdr) + return $ processRec hdr record + + +-- Attach handlers for specific headers here +processRec :: Header -> ByteString -> Rec +processRec hdr = runGet (specificGet hdr) + +specificGet :: Header -> Get Rec +specificGet (Header _ 0 10) = getFar +specificGet (Header _ 5 20) = getPrr +specificGet (Header len _ _) = getRawRec len + +getBinRec :: Get BinRec +getBinRec = do + hdr <- getHeader + record <- getRec hdr + return $! BinRec hdr record -- needs to be strict? + +getHeader :: Get Header +getHeader = Header <$> getWord16le <*> getWord8 <*> getWord8 + +nextRec :: Get Rec +nextRec = do + record <- getBinRec + return $ rec record + + +getStdf :: Get Stdf +getStdf = do + empty <- isEmpty + if empty + then return [] + else do record <- nextRec + recs <- getStdf + return (record:recs) + +parse :: ByteString -> Stdf +parse = runGet getStdf diff --git a/Data/Stdf/WaferMap.hs b/Data/Stdf/WaferMap.hs new file mode 100644 --- /dev/null +++ b/Data/Stdf/WaferMap.hs @@ -0,0 +1,108 @@ + +{-# LANGUAGE OverloadedStrings #-} + +-- TODO: factoring this interface +module Data.Stdf.WaferMap ( XyBin(..) + , stdfToXyBin + , xybsToGrid + , gridToString + , stdfToWaferMapString + ) where + +import Data.Stdf +import qualified Data.ByteString.Lazy as BL +import Data.Aeson +import Data.Maybe (fromJust) +import Data.List (sortBy, groupBy) +import Data.Function (on) +import Data.Ix (range) +import Data.List.Split (chunksOf) + +data XyBin = XyBin { x :: Int + , y :: Int + , bin :: Int } + | Missing + deriving Show + +stdfToXyBin :: Stdf -> [XyBin] +stdfToXyBin (prr@(Prr { xCoord = Just xc + , yCoord = Just yc + , hardBin = hb }):prrs) = + XyBin { x = fromIntegral xc + , y = fromIntegral yc + , bin = fromIntegral hb } : stdfToXyBin prrs +stdfToXyBin (_:prrs) = stdfToXyBin prrs +stdfToXyBin [] = [] + +-- Take a list of XyBin sorted by x,y and a list of all x,y in the wafer map +-- Make a list of XyBin with Missing inserted where there wasn't an XyBin for +-- a given x,y +addmissing :: [XyBin] -> [(Int, Int)] -> [XyBin] +addmissing [] [] = [] +addmissing [] xys = replicate (length xys) Missing +addmissing (d:ds) (xy:xys) + | x d == fst xy && y d == snd xy = d : addmissing ds xys + | otherwise = Missing : addmissing (d:ds) xys + + +binToStr :: Maybe Int -> String +binToStr Nothing = "." +binToStr (Just bn) = show bn + +-- sort by y,x +-- groupby y,x +-- take lowest bin # from groups +-- use min max x y to insert Missing dies +xybsToGrid :: [XyBin] -> [[XyBin]] +xybsToGrid xybs = mkgrid cols gridlist + where ordXy a b = case compare (y a) (y b) of + EQ -> compare (x a) (x b) + ordy -> ordy + eqXy a b = x a == x b && y a == y b + ordBin a b = compare (bin a) (bin b) + waferxy = [(atx, aty) | aty <- range (miny, maxy) + , atx <- range (minx, maxx)] + sortedxy = sortBy ordXy xybs + groupedxy = groupBy eqXy sortedxy + sortedbin = map (sortBy ordBin) groupedxy + dropedextra = map head sortedbin + xs = map x dropedextra + ys = map y dropedextra + minx = minimum xs + maxx = maximum xs + miny = minimum ys + maxy = maximum ys + gridlist = addmissing dropedextra waferxy + cols = maxx - minx + 1 + +mkgrid :: Int -> [a] -> [[a]] +mkgrid = chunksOf + +-- take list of rows +-- convert to rows with columns of show bin +-- pad to maximum show bin width +-- print +gridToString :: [[XyBin]] -> String +gridToString xybs = unlines $ map unwords padded + where + pad w s = s ++ replicate (w - length s) ' ' + + binOrNothing Missing = Nothing + binOrNothing XyBin { bin = bin } = Just bin + + bins = map2d binOrNothing xybs -- start here + binstrs :: [[String]] + binstrs = map2d binToStr bins + maxwidth :: Int + maxwidth = maximum $ (concatMap . map) length binstrs + padded = map2d (pad maxwidth) binstrs + cols = length $ head xybs + rows = length xybs + +map2d :: (a -> b) -> [[a]] -> [[b]] +map2d = map . map + +stdfToWaferMapString :: Stdf -> String +stdfToWaferMapString bodies = let xybs = stdfToXyBin bodies + grid = xybsToGrid xybs + in gridToString grid diff --git a/Examples/StdfToJson.hs b/Examples/StdfToJson.hs new file mode 100644 --- /dev/null +++ b/Examples/StdfToJson.hs @@ -0,0 +1,27 @@ + +module Main where + +import Data.Stdf +import qualified Data.ByteString.Lazy.Char8 as BL +import System.Environment (getArgs) +import System.Exit (exitFailure) +import Control.Monad (when) +import Data.Aeson + +printUsage = putStrLn "usage: StdfToJson file.stdf" + +-- unparsed records have type Raw for the time being +notRaw :: Rec -> Bool +notRaw (Raw _) = False +notRaw _ = True + +main = do + args <- getArgs + when (length args /= 1) $ do + printUsage + exitFailure + let file = head args + raw <- BL.readFile file + let recs = parse raw + let goodRecs = filter notRaw recs + mapM_ (BL.putStrLn . encode) goodRecs diff --git a/Examples/WaferMap.hs b/Examples/WaferMap.hs new file mode 100644 --- /dev/null +++ b/Examples/WaferMap.hs @@ -0,0 +1,21 @@ + +module Main where + +import Data.Stdf +import Data.Stdf.WaferMap +import qualified Data.ByteString.Lazy as BL +import System.Environment (getArgs) +import System.Exit (exitFailure) +import Control.Monad (when) + +printUsage = putStrLn "usage: WaferMap file.stdf" + +main = do + args <- getArgs + when (length args /= 1) $ do + printUsage + exitFailure + let file = head args + putStrLn $ "File: " ++ file + raw <- BL.readFile file + putStrLn $ stdfToWaferMapString (parse raw) diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, 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. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +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 give any other recipients of the Program a copy of this License +along with the Program. + +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 Program or any portion +of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +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 Program, 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 Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) 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; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, 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 executable. However, as a +special exception, the source code 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. + +If distribution of executable or 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 counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program 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. + + 5. 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 Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program 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 to +this License. + + 7. 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 Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program 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 Program. + +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. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program 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. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 Program +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 Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, 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 + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. 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 PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), 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 Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. 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. + + + Copyright (C) + + 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 Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/Readme.md b/Readme.md new file mode 100644 --- /dev/null +++ b/Readme.md @@ -0,0 +1,74 @@ +Data.Stdf +========= + +Structured Test Data Format (STDF) is used to log test data by semiconductor automated test equipment (ATE). + +There's a couple of good, open-source libraries for parsing STDF, notably [PyStdf](https://github.com/cmars/pystdf). + + +The Data.Stdf advantage +----------------------- + +1. Haskell +2. Fast + + +Install +------- + + cabal install stdf -- Is a TODO. Just clone and build the package + +Usage +----- + +Here's an example of converting STDF to JSON. (What else would you want to do +with it?) + + import Data.Stdf + import qualified Data.ByteString.Lazy.Char8 as BL + import Data.Aeson + + -- unparsed records have type Raw for the time being + notRaw :: Rec -> Bool + notRaw (Raw _) = False + notRaw _ = True + + main = do + raw <- BL.readFile "test.stdf" + let recs = parse raw + let goodRecs = filter notRaw recs + mapM_ (BL.putStrLn . encode) goodRecs + + +Included Examples Applications +------------------------------ + +* WaferMap -- prints a pretty wafermap like this: + +``` +$ Examples/WaferMap test.stdf +File: test.stdf +. . . . . 11 11 11 11 11 . . . . . . +. . . 11 11 11 11 6 1 6 11 11 11 . . . +. . 11 11 1 11 11 11 1 11 1 1 11 11 . . +. 1 1 1 11 1 1 1 1 6 6 6 1 1 11 . +203 11 11 11 11 11 1 6 11 1 1 11 1 11 11 . +11 11 11 11 1 11 6 1 1 1 11 11 11 11 11 11 +11 11 11 11 1 1 11 1 11 6 1 11 1 11 11 11 +203 11 11 1 1 11 6 1 11 212 6 1 11 11 11 . +. 200 6 11 1 1 1 1 1 6 11 1 1 11 11 . +. . 11 11 11 11 1 1 1 11 1 1 1 11 . . +. . . 11 11 1 11 11 1 11 11 11 11 . . . +. . . . . 11 11 11 11 200 212 . . . . . +``` + +* StdfToJson -- prints each Stdf record as a one-line JSON object for easy importing into other languages for further processing + + +Now the Bad News +---------------- + +Data.Stdf currently only parses the PRR record because that's all I needed. +Well, the code is short and sweet so it won't be too much work to add support +for some more interesting records. I can't think of why I'd bother with all of +the rarely-used uninteresting ones. But maybe if I'm bored. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/stdf.cabal b/stdf.cabal new file mode 100644 --- /dev/null +++ b/stdf.cabal @@ -0,0 +1,84 @@ +-- Initial stdf.cabal generated by cabal init. For further documentation, +-- see http://haskell.org/cabal/users-guide/ + +-- The name of the package. +name: stdf + +-- The package version. See the Haskell package versioning policy (PVP) +-- for standards guiding when and how versions should be incremented. +-- http://www.haskell.org/haskellwiki/Package_versioning_policy +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.1.0.0 + +-- A short (one-line) description of the package. +synopsis: Parse Structured Test Data Format (STDF) + +-- A longer description of the package. +-- description: + +-- URL for the project homepage or repository. +homepage: https://github.com/gitfoxi/Stdf + +-- The license under which the package is released. +license: GPL-2 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: Michael Fox + +-- An email address to which users can send suggestions, bug reports, and +-- patches. +maintainer: 415fox@gmail.com + +-- A copyright notice. +-- copyright: + +category: Data + +build-type: Simple + +-- Extra files to be distributed with the package, such as examples or a +-- README. +extra-source-files: Readme.md + +-- Constraint on the version of Cabal needed to build this package. +cabal-version: >=1.10 + + +library + -- Modules exported by the library. + exposed-modules: Data.Stdf, Data.Stdf.WaferMap + + -- Modules included in this library but not exported. + -- other-modules: + + -- LANGUAGE extensions used by modules in this package. + other-extensions: NegativeLiterals, DeriveGeneric, OverloadedStrings + + -- Other library packages from which modules are imported. + build-depends: base >=4.7 && <4.8, bytestring >=0.10 && <0.11, binary >=0.7 && <0.8, text >=1.1 && <1.2, base64-bytestring >=1.0 && <1.1, aeson >=0.8 && <0.9, split >=0.2 && <0.3 + + -- Directories containing source files. + hs-source-dirs: . + + -- Base language which the package is written in. + default-language: Haskell2010 + GHC-Options: -O2 + +Executable StdfToJson + main-is: StdfToJson.hs + hs-source-dirs: Examples + default-language: Haskell2010 + GHC-Options: -O2 + build-depends: base >=4.7 && <4.8, bytestring >=0.10 && <0.11, binary >=0.7 && <0.8, text >=1.1 && <1.2, base64-bytestring >=1.0 && <1.1, aeson >=0.8 && <0.9, split >=0.2 && <0.3, stdf + +Executable WaferMap + main-is: WaferMap.hs + hs-source-dirs: Examples + default-language: Haskell2010 + GHC-Options: -O2 + build-depends: base >=4.7 && <4.8, bytestring >=0.10 && <0.11, binary >=0.7 && <0.8, text >=1.1 && <1.2, base64-bytestring >=1.0 && <1.1, aeson >=0.8 && <0.9, split >=0.2 && <0.3, stdf