From 0a0756c2b54838126a9f4fb0fd0563ba3399916b Mon Sep 17 00:00:00 2001 From: Adam Preble Date: Tue, 19 May 2009 21:08:38 -0400 Subject: [PATCH] Initial commit. --- .gitignore | 3 + Doxyfile | 1543 ++++++++++++++++++++++++++ Makefile | 23 + README.markdown | 29 + examples/pinproctest/Makefile | 28 + examples/pinproctest/pinproctest.cpp | 188 ++++ include/pinproc.h | 225 ++++ libpinproc.xcodeproj/project.pbxproj | 333 ++++++ src/PRDevice.cpp | 652 +++++++++++ src/PRDevice.h | 143 +++ src/PRHardware.cpp | 171 +++ src/PRHardware.h | 153 +++ src/pinproc.cpp | 142 +++ 13 files changed, 3633 insertions(+) create mode 100644 .gitignore create mode 100644 Doxyfile create mode 100644 Makefile create mode 100644 README.markdown create mode 100644 examples/pinproctest/Makefile create mode 100644 examples/pinproctest/pinproctest.cpp create mode 100644 include/pinproc.h create mode 100644 libpinproc.xcodeproj/project.pbxproj create mode 100644 src/PRDevice.cpp create mode 100644 src/PRDevice.h create mode 100644 src/PRHardware.cpp create mode 100644 src/PRHardware.h create mode 100644 src/pinproc.cpp diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8248aa2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +build/ +*/*.pbxuser +*/*.perspectivev3 diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..a37bd4d --- /dev/null +++ b/Doxyfile @@ -0,0 +1,1543 @@ +# Doxyfile 1.5.9 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = libpinproc + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 0.1 + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./docs + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = /Users/dimitri/doxygen/mail/1.5.7/doxywizard/ + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. Note that for custom extensions you also need to set +# FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = YES + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ./include + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.vhd \ + *.vhdl + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. Other possible values +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. + +GENERATE_TREEVIEW = NONE + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = NO + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Options related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ceabe44 --- /dev/null +++ b/Makefile @@ -0,0 +1,23 @@ +# +# File: Makefile (for library) +# +CC=g++ +LIB=libpinproc.a +LIBDEST=./ + +LIBSRC=src/pinproc.cpp src/PRDevice.cpp src/PRHardware.cpp + +LIBOBJ=$(LIBSRC:.cpp=.o) + +#CXXFLAGS=-I/usr/local/lib -lusb -lftdi + +$(LIB): $(LIBOBJ) + @echo lib Makefile - archiving $(LIB) + $(AR) r $(LIB) $(LIBOBJ) + +.cpp.o: + @echo lib Makefile - compiling $< + $(CC) $(CXXFLAGS) -c $< -o $@ + +clean: + rm -f $(LIBOBJ) $(LIB) diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..c6ddabc --- /dev/null +++ b/README.markdown @@ -0,0 +1,29 @@ +## libpinproc + +Library for Gerry Stellenberg's [P-ROC](http://pinballcontrollers.com/) (Pinball Remote Operations Controller). + +### License + +The MIT License +Copyright (c) 2009 Gerry Stellenberg, Adam Preble + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. diff --git a/examples/pinproctest/Makefile b/examples/pinproctest/Makefile new file mode 100644 index 0000000..db31cb6 --- /dev/null +++ b/examples/pinproctest/Makefile @@ -0,0 +1,28 @@ +# +# File: Makefile for application +# +CC=g++ +LDFLAGS=-L../.. -L/usr/local/lib +LIBS=-lpinproc -lusb -lftdi + +SRC=pinproctest.cpp + +CXXFLAGS=-I../../include + +OBJS=$(SRC:.cpp=.o) + +EXE=pinproctest + +all: $(EXE) + +# FIXME: This makes the exe require libpinproc but not in a very graceful way. +$(EXE): $(OBJS) ../../libpinproc.a + @echo application Makefile - linking $< + $(CC) $^ $(LDFLAGS) $(LIBS) -o $@ + +.cpp.o: + @echo application Makefile - compiling $< + $(CC) $(CXXFLAGS) -c $< -o $@ + +clean: + rm -f $(OBJS) $(EXE) diff --git a/examples/pinproctest/pinproctest.cpp b/examples/pinproctest/pinproctest.cpp new file mode 100644 index 0000000..b9c274f --- /dev/null +++ b/examples/pinproctest/pinproctest.cpp @@ -0,0 +1,188 @@ +/* + * The MIT License + * Copyright (c) 2009 Gerry Stellenberg, Adam Preble + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ +/* + * pinproctest.cpp + * libpinproc + */ +#include +#include +#include +#include +#include "pinproc.h" // Include libpinproc's header. + +/** Demonstration of the custom logging callback. */ +void TestLogger(const char *text) +{ + fprintf(stderr, "TEST: %s", text); +} + +void ConfigureDrivers(PRHandle proc) +{ + int i; + + PRDriverGlobalConfig globals; + globals.enableOutputs = false; + globals.globalPolarity = false; + globals.useClear = false; + globals.strobeStartSelect = false; + globals.startStrobeTime = 4; // milliseconds per output loop + globals.matrixRowEnableIndex1 = 12; + globals.matrixRowEnableIndex0 = 6; + globals.activeLowMatrixRows = true; + globals.tickleWatchdog = false; + globals.encodeEnables = false; + + // We want to start up safely, so we'll update the global driver config twice. + // When we toggle enableOutputs like this P-ROC will reset the polarity: + + // Enable now without the outputs enabled: + PRDriverUpdateGlobalConfig(proc, &globals); + + // Now enable the outputs: (TODO: Why?) + globals.enableOutputs = true; + PRDriverUpdateGlobalConfig(proc, &globals); + + // Configure the groups: + + PRDriverGroupConfig group; + for (i = 0; i < 6; i++) + { + PRDriverGetGroupConfig(proc, i + 4, &group); + group.slowTime = 0; + group.enableIndex = i; + group.rowActivateIndex = i; + group.rowEnableSelect = 0; + group.matrixed = false; + group.polarity = false; + group.active = 1; + group.disableStrobeAfter = false; + + PRDriverUpdateGroupConfig(proc, &group); + } + + for (i = 6; i < 14; i++) { + PRDriverGetGroupConfig(proc, i + 4, &group); + group.slowTime = 400; + group.enableIndex = 7; + group.rowActivateIndex = i - 6; + group.rowEnableSelect = 0; + group.matrixed = 1; + group.polarity = 0; + group.active = 1; + group.disableStrobeAfter = 1; + PRDriverUpdateGroupConfig(proc, &group); + } +} + +void ConfigureSwitches(PRHandle proc) +{ + int i; + + // Create a basic driver for all of the switches to default to: + PRDriverState defaultDriver; + memset(&defaultDriver, 0x0, sizeof(defaultDriver)); // Set all fields to 0. + + for (i = 0; i <= kPRSwitchPhysicalLast; i++) + { + PRSwitchRule sw; + sw.switchNum = i; + sw.notifyHost = true; + sw.changeOutput = false; + sw.linkActive = false; + sw.linkAddress = 0; + sw.eventType = kPREventTypeSwitchClosedDebounced; + sw.driver = defaultDriver; + PRSwitchesUpdateRules(proc, &sw, 1); + sw.eventType = kPREventTypeSwitchOpenDebounced; + PRSwitchesUpdateRules(proc, &sw, 1); + } +} + +bool runLoopRun = true; + +void RunLoop(PRHandle proc) +{ + const int maxEvents = 16; + PREvent events[maxEvents]; + while (runLoopRun) + { + int numEvents = PRGetEvents(proc, events, maxEvents); + for (int i = 0; i < numEvents; i++) + { + PREvent *event = &events[i]; + const char *stateText = "Unknown"; + switch (event->type) + { + case kPREventTypeSwitchOpenDebounced: stateText = "open"; break; + case kPREventTypeSwitchClosedDebounced: stateText = "closed"; break; + case kPREventTypeSwitchOpenNondebounced: stateText = "open(ndb)"; break; + case kPREventTypeSwitchClosedNondebounced: stateText = "closed(ndb)"; break; + } + printf("switch % 3d: %s\n", event->value, stateText); + } + usleep(10*1000); // Sleep for 10ms so we aren't pegging the CPU. + } +} + +void sigint(int) +{ + runLoopRun = false; + signal(SIGINT, SIG_DFL); // Re-install the default signal handler. + printf("Exiting...\n"); +} + +int main(const char **argv, int argc) +{ + // Set a signal handler so that we can exit gracefully on Ctrl-C: + signal(SIGINT, sigint); + + // Assign a custom logging callback to demonstrate capturing log information from P-ROC: + PRLogSetCallback(TestLogger); + + // Finally instantiate the P-ROC device: + PRHandle proc = PRCreate(kPRMachineWPC); + if (proc == kPRHandleInvalid) + return 1; + + printf("Configuring P-ROC...\n"); + + ConfigureDrivers(proc); + ConfigureSwitches(proc); + + printf("Running. Hit Ctrl-C to exit.\n"); + + // Pulse a coil to test: +// PRDriverDisable(proc, 80); +// PRDriverPulse(proc, 53, 100); + + RunLoop(proc); + + // Destroy the P-ROC device handle: + PRDelete(proc); + proc = kPRHandleInvalid; + + return 0; +} \ No newline at end of file diff --git a/include/pinproc.h b/include/pinproc.h new file mode 100644 index 0000000..95ebd4f --- /dev/null +++ b/include/pinproc.h @@ -0,0 +1,225 @@ +/* + * The MIT License + * Copyright (c) 2009 Gerry Stellenberg, Adam Preble + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ +/** @file pinproc.h + * @brief libpinproc, P-ROC Layer 1 API (Preliminary) + * + */ + +#ifndef _PINPROC_H_ +#define _PINPROC_H_ + +#include + +/** @cond */ +#if defined(__WIN32__) + #undef PR_EXPORT + #if defined(PR_BUILDING_PR) + #define PR_EXPORT __declspec(dllexport) extern + #else + #define PR_EXPORT __declspec(dllimport) extern + #endif +#endif + +#if !defined(PR_EXPORT) + #define PR_EXPORT extern +#endif + +#if !defined(PR_EXTERN_C_BEGIN) + #if defined(__cplusplus) + #define PR_EXTERN_C_BEGIN extern "C" { + #define PR_EXTERN_C_END } + #else + #define PR_EXTERN_C_BEGIN + #define PR_EXTERN_C_END + #endif +#endif +/** @endcond */ + +/** @cond */ +PR_EXTERN_C_BEGIN +/** @endcond */ + +// Types + +typedef int32_t bool_t; // FIXME: This needs better platform independence. + +typedef int32_t PRResult; /**< See: #kPRSuccess and #kPRFailure. */ +#define kPRSuccess (1) /**< Success value for #PRResult. */ +#define kPRFailure (0) /**< Failure value for #PRResult. */ + +typedef void * PRHandle; /**< Opaque type used to reference an individual P-ROC device. Created with PRCreate() and destroyed with PRDelete(). This value is used as the first parameter to all P-ROC API function calls. */ +#define kPRHandleInvalid (0) /**< Value returned by PRCreate() on failure. Indicates an invalid #PRHandle. */ + +typedef void (*PRLogCallback)(const char *text); /**< Function pointer type for a custom logging callback. See: PRLogSetCallback(). */ +PR_EXPORT void PRLogSetCallback(PRLogCallback callback); /**< Replaces the default logging handler with the given callback function. */ + +typedef enum PRMachineType { + kPRMachineInvalid = 0, + kPRMachineCustom = 1, + kPRMachineWPC = 2, + kPRMachineStern = 3, // May be split into kPRMachineWhitestar and kPRMachineSAM. +} PRMachineType; + +// PRHandle Creation and Deletion + +PR_EXPORT PRHandle PRCreate(PRMachineType machineType); /**< Create a new P-ROC device handle. Only one handle per device may be created. This handle must be destroyed with PRDelete() when it is no longer needed. Returns #kPRHandleInvalid if an error occurred. */ +PR_EXPORT void PRDelete(PRHandle handle); /**< Destroys an existing P-ROC device handle. */ + + +// Events +// Closed == 0, Open == 1 +typedef enum PREventType { + kPREventTypeInvalid = 0, + kPREventTypeSwitchClosedDebounced = 1, /**< The switch has gone from open to closed and the signal has been debounced. */ + kPREventTypeSwitchOpenDebounced = 2, /**< The switch has gone from closed to open and the signal has been debounced. */ + kPREventTypeSwitchClosedNondebounced = 3, /**< The switch has gone from open to closed and the signal has not been debounced. */ + kPREventTypeSwitchOpenNondebounced = 4, /**< The switch has gone from closed to open and the signal has not been debounced. */ + kPREventTypetLast = kPREventTypeSwitchOpenNondebounced +} PREventType; + +typedef struct PREvent { + PREventType type; /**< The type of event that has occurred. Usually a switch event at this point. */ + uint32_t value; /**< For switch events, the switch number that has changed. */ + uint32_t time; /**< Time (in milliseconds) that this event occurred. */ +} PREvent; + +/** Get all of the available events that have been received. */ +PR_EXPORT int PRGetEvents(PRHandle handle, PREvent *eventsOut, int maxEvents); + + +// Drivers + +typedef struct PRDriverGlobalConfig { + bool_t enableOutputs; // Formerly enable_direct_outputs + bool_t globalPolarity; + bool_t useClear; + bool_t strobeStartSelect; + uint8_t startStrobeTime; + uint8_t matrixRowEnableIndex1; + uint8_t matrixRowEnableIndex0; + bool_t activeLowMatrixRows; + bool_t encodeEnables; + bool_t tickleWatchdog; +} PRDriverGlobalConfig; + +typedef struct PRDriverGroupConfig { + uint8_t groupNum; + uint16_t slowTime; + uint8_t enableIndex; + uint8_t rowActivateIndex; + uint8_t rowEnableSelect; + bool_t matrixed; + bool_t polarity; + bool_t active; + bool_t disableStrobeAfter; +} PRDriverGroupConfig; + +typedef struct PRDriverState { + uint16_t driverNum; + uint32_t outputDriveTime; + bool_t polarity; + bool_t state; + bool_t waitForFirstTimeSlot; + uint32_t timeslots; + uint8_t patterOnTime; + uint8_t patterOffTime; + bool_t patterEnable; +} PRDriverState; + +/** Update registers for the global driver configuration. */ +PR_EXPORT PRResult PRDriverUpdateGlobalConfig(PRHandle handle, PRDriverGlobalConfig *driverGlobalConfig); + +PR_EXPORT PRResult PRDriverGetGroupConfig(PRHandle handle, uint8_t groupNum, PRDriverGroupConfig *driverGroupConfig); +/** Update registers for the given driver group configuration. */ +PR_EXPORT PRResult PRDriverUpdateGroupConfig(PRHandle handle, PRDriverGroupConfig *driverGroupConfig); + +PR_EXPORT PRResult PRDriverGetState(PRHandle handle, uint8_t driverNum, PRDriverState *driverState); +/** Sets the state of the given driver (lamp, coil, etc.). */ +PR_EXPORT PRResult PRDriverUpdateState(PRHandle handle, PRDriverState *driverState); + +// Driver Helper functions: + +/** Disables (turns off) the given driver. */ +PR_EXPORT PRResult PRDriverDisable(PRHandle handle, uint16_t driverNum); +/** Pulses the given driver for a number of milliseconds. */ +PR_EXPORT PRResult PRDriverPulse(PRHandle handle, uint16_t driverNum, int milliseconds); +/** Assigns a repeating schedule to the given driver. */ +PR_EXPORT PRResult PRDriverSchedule(PRHandle handle, uint16_t driverNum, uint32_t schedule, uint8_t cycleSeconds, bool_t now); + +PR_EXPORT PRResult PRDriverPatter(PRHandle handle, uint16_t driverNum, uint16_t millisecondsOn, uint16_t millisecondsOff, uint16_t originalOnTime); + + + +// Switches + +/** @defgroup switchconsts Switch Constants + * @{ + */ +#define kPRSwitchPhysicalFirst (0) /**< Switch number of the first physical switch. */ +#define kPRSwitchPhysicalLast (223) /**< Switch number of the last physical switch. */ +#define kPRSwitchVirtualFirst (224) /**< Switch number of the first virtual switch. */ +#define kPRSwitchVirtualLast (255) /**< Switch number of the last virtual switch. */ +/** @} */ + +typedef struct PRSwitchRule { + uint16_t switchNum; /**< Number of the physical switch, or for linked driver changes the virtual switch number (224 and up). */ + PREventType eventType; /**< The event type that this rule generates. Determines closed/open, debounced/non-debounced. */ + bool_t notifyHost; + bool_t changeOutput; /**< True if this switch rule should affect a driver output change. */ + bool_t linkActive; /**< True if this switch rule has additional linked driver updates. */ + uint32_t linkAddress; /**< Switch number of the linked driver update. */ + PRDriverState driver; /**< Driver state change to affect once this rule is triggered. */ +} PRSwitchRule; + +/** Updates the rules for the given switch and PREventType combinations. */ +PR_EXPORT PRResult PRSwitchesUpdateRules(PRHandle handle, PRSwitchRule *rules, int numRules); + + + +// DMD + +typedef struct PRDMDGlobalConfig { + uint8_t numRows; + uint16_t numColumns; + uint8_t numSubFrames; + uint16_t cyclesPerRow; + bool_t enable; + uint8_t rclkLowCycles[8]; + uint8_t latchHighCycles[8]; + uint16_t deHighCycles[8]; + uint8_t dotclkHalfPeriod[8]; +} PRDMDConfig; + +/** Sets the configuration registers for the DMD driver. */ +PR_EXPORT int32_t PRDMDUpdateGlobalConfig(PRHandle handle, PRDMDGlobalConfig *dmdGlobalConfig); +/** Updates the DMD frame buffer with the given data. */ +PR_EXPORT PRResult PRDMDDraw(PRHandle handle, uint8_t * dots, uint16_t columns, uint8_t rows, uint8_t numSubFrames); + +/** @cond */ +PR_EXTERN_C_END +/** @endcond */ + +#endif // _PINPROC_H_ diff --git a/libpinproc.xcodeproj/project.pbxproj b/libpinproc.xcodeproj/project.pbxproj new file mode 100644 index 0000000..98001c9 --- /dev/null +++ b/libpinproc.xcodeproj/project.pbxproj @@ -0,0 +1,333 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 45; + objects = { + +/* Begin PBXBuildFile section */ + 6682492C0FC079050051560E /* pinproc.h in Headers */ = {isa = PBXBuildFile; fileRef = 6682492B0FC079050051560E /* pinproc.h */; }; + 6682493A0FC07B2A0051560E /* pinproc.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 668249390FC07B2A0051560E /* pinproc.cpp */; }; + 668249420FC07D900051560E /* PRDevice.h in Headers */ = {isa = PBXBuildFile; fileRef = 668249400FC07D900051560E /* PRDevice.h */; }; + 668249430FC07D900051560E /* PRDevice.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 668249410FC07D900051560E /* PRDevice.cpp */; }; + 6682494B0FC0870B0051560E /* PRHardware.h in Headers */ = {isa = PBXBuildFile; fileRef = 6682494A0FC0870B0051560E /* PRHardware.h */; }; + 668249E30FC0A3960051560E /* pinproctest.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 668249E20FC0A3960051560E /* pinproctest.cpp */; }; + 668249EA0FC0A4280051560E /* libpinproc.a in Frameworks */ = {isa = PBXBuildFile; fileRef = D2AAC046055464E500DB518D /* libpinproc.a */; }; + 668249ED0FC0A4CD0051560E /* PRHardware.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 668249EC0FC0A4CD0051560E /* PRHardware.cpp */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 668249E40FC0A3C40051560E /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 08FB7793FE84155DC02AAC07 /* Project object */; + proxyType = 1; + remoteGlobalIDString = D2AAC045055464E500DB518D; + remoteInfo = libpinproc; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXFileReference section */ + 6682492B0FC079050051560E /* pinproc.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = pinproc.h; path = include/pinproc.h; sourceTree = ""; }; + 668249390FC07B2A0051560E /* pinproc.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = pinproc.cpp; path = src/pinproc.cpp; sourceTree = ""; }; + 668249400FC07D900051560E /* PRDevice.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = PRDevice.h; path = src/PRDevice.h; sourceTree = ""; }; + 668249410FC07D900051560E /* PRDevice.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = PRDevice.cpp; path = src/PRDevice.cpp; sourceTree = ""; }; + 6682494A0FC0870B0051560E /* PRHardware.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = PRHardware.h; path = src/PRHardware.h; sourceTree = ""; }; + 668249D90FC0A30A0051560E /* pinproctest */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = pinproctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 668249E20FC0A3960051560E /* pinproctest.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = pinproctest.cpp; path = examples/pinproctest/pinproctest.cpp; sourceTree = ""; }; + 668249EC0FC0A4CD0051560E /* PRHardware.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; name = PRHardware.cpp; path = src/PRHardware.cpp; sourceTree = ""; }; + D2AAC046055464E500DB518D /* libpinproc.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libpinproc.a; sourceTree = BUILT_PRODUCTS_DIR; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 668249D70FC0A30A0051560E /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 668249EA0FC0A4280051560E /* libpinproc.a in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + D289987405E68DCB004EDB86 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 08FB7794FE84155DC02AAC07 /* libpinproc */ = { + isa = PBXGroup; + children = ( + 08FB7795FE84155DC02AAC07 /* Source */, + C6A0FF2B0290797F04C91782 /* Documentation */, + 1AB674ADFE9D54B511CA2CBB /* Products */, + ); + name = libpinproc; + sourceTree = ""; + }; + 08FB7795FE84155DC02AAC07 /* Source */ = { + isa = PBXGroup; + children = ( + 668249D30FC0A2C10051560E /* pinproctest */, + 668249D20FC0A29E0051560E /* libpinproc */, + ); + name = Source; + sourceTree = ""; + }; + 1AB674ADFE9D54B511CA2CBB /* Products */ = { + isa = PBXGroup; + children = ( + D2AAC046055464E500DB518D /* libpinproc.a */, + 668249D90FC0A30A0051560E /* pinproctest */, + ); + name = Products; + sourceTree = ""; + }; + 668249D20FC0A29E0051560E /* libpinproc */ = { + isa = PBXGroup; + children = ( + 6682492B0FC079050051560E /* pinproc.h */, + 668249390FC07B2A0051560E /* pinproc.cpp */, + 668249400FC07D900051560E /* PRDevice.h */, + 668249410FC07D900051560E /* PRDevice.cpp */, + 6682494A0FC0870B0051560E /* PRHardware.h */, + 668249EC0FC0A4CD0051560E /* PRHardware.cpp */, + ); + name = libpinproc; + sourceTree = ""; + }; + 668249D30FC0A2C10051560E /* pinproctest */ = { + isa = PBXGroup; + children = ( + 668249E20FC0A3960051560E /* pinproctest.cpp */, + ); + name = pinproctest; + sourceTree = ""; + }; + C6A0FF2B0290797F04C91782 /* Documentation */ = { + isa = PBXGroup; + children = ( + ); + name = Documentation; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXHeadersBuildPhase section */ + D2AAC043055464E500DB518D /* Headers */ = { + isa = PBXHeadersBuildPhase; + buildActionMask = 2147483647; + files = ( + 6682492C0FC079050051560E /* pinproc.h in Headers */, + 668249420FC07D900051560E /* PRDevice.h in Headers */, + 6682494B0FC0870B0051560E /* PRHardware.h in Headers */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXHeadersBuildPhase section */ + +/* Begin PBXNativeTarget section */ + 668249D80FC0A30A0051560E /* pinproctest */ = { + isa = PBXNativeTarget; + buildConfigurationList = 668249DD0FC0A32A0051560E /* Build configuration list for PBXNativeTarget "pinproctest" */; + buildPhases = ( + 668249D60FC0A30A0051560E /* Sources */, + 668249D70FC0A30A0051560E /* Frameworks */, + ); + buildRules = ( + ); + dependencies = ( + 668249E50FC0A3C40051560E /* PBXTargetDependency */, + ); + name = pinproctest; + productName = pinproctest; + productReference = 668249D90FC0A30A0051560E /* pinproctest */; + productType = "com.apple.product-type.tool"; + }; + D2AAC045055464E500DB518D /* libpinproc */ = { + isa = PBXNativeTarget; + buildConfigurationList = 1DEB91EB08733DB70010E9CD /* Build configuration list for PBXNativeTarget "libpinproc" */; + buildPhases = ( + D2AAC043055464E500DB518D /* Headers */, + D2AAC044055464E500DB518D /* Sources */, + D289987405E68DCB004EDB86 /* Frameworks */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = libpinproc; + productName = libpinproc; + productReference = D2AAC046055464E500DB518D /* libpinproc.a */; + productType = "com.apple.product-type.library.static"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 08FB7793FE84155DC02AAC07 /* Project object */ = { + isa = PBXProject; + buildConfigurationList = 1DEB91EF08733DB70010E9CD /* Build configuration list for PBXProject "libpinproc" */; + compatibilityVersion = "Xcode 3.1"; + hasScannedForEncodings = 1; + mainGroup = 08FB7794FE84155DC02AAC07 /* libpinproc */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + D2AAC045055464E500DB518D /* libpinproc */, + 668249D80FC0A30A0051560E /* pinproctest */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXSourcesBuildPhase section */ + 668249D60FC0A30A0051560E /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 668249E30FC0A3960051560E /* pinproctest.cpp in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + D2AAC044055464E500DB518D /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 6682493A0FC07B2A0051560E /* pinproc.cpp in Sources */, + 668249430FC07D900051560E /* PRDevice.cpp in Sources */, + 668249ED0FC0A4CD0051560E /* PRHardware.cpp in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 668249E50FC0A3C40051560E /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = D2AAC045055464E500DB518D /* libpinproc */; + targetProxy = 668249E40FC0A3C40051560E /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin XCBuildConfiguration section */ + 1DEB91EC08733DB70010E9CD /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + COPY_PHASE_STRIP = NO; + GCC_DYNAMIC_NO_PIC = NO; + GCC_ENABLE_FIX_AND_CONTINUE = YES; + GCC_MODEL_TUNING = G5; + GCC_OPTIMIZATION_LEVEL = 0; + HEADER_SEARCH_PATHS = /usr/local/include; + INSTALL_PATH = /usr/local/lib; + PRODUCT_NAME = pinproc; + }; + name = Debug; + }; + 1DEB91ED08733DB70010E9CD /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + GCC_MODEL_TUNING = G5; + HEADER_SEARCH_PATHS = /usr/local/include; + INSTALL_PATH = /usr/local/lib; + PRODUCT_NAME = pinproc; + }; + name = Release; + }; + 1DEB91F008733DB70010E9CD /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ARCHS = "$(ARCHS_STANDARD_32_BIT)"; + GCC_C_LANGUAGE_STANDARD = c99; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_WARN_ABOUT_RETURN_TYPE = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + ONLY_ACTIVE_ARCH = YES; + PREBINDING = NO; + SDKROOT = macosx10.5; + }; + name = Debug; + }; + 1DEB91F108733DB70010E9CD /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ARCHS = "$(ARCHS_STANDARD_32_BIT)"; + GCC_C_LANGUAGE_STANDARD = c99; + GCC_WARN_ABOUT_RETURN_TYPE = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + PREBINDING = NO; + SDKROOT = macosx10.5; + }; + name = Release; + }; + 668249DB0FC0A30A0051560E /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + COPY_PHASE_STRIP = NO; + GCC_DYNAMIC_NO_PIC = NO; + GCC_ENABLE_FIX_AND_CONTINUE = YES; + GCC_MODEL_TUNING = G5; + GCC_OPTIMIZATION_LEVEL = 0; + INSTALL_PATH = /usr/local/bin; + OTHER_LDFLAGS = "-lftdi"; + PREBINDING = NO; + PRODUCT_NAME = pinproctest; + }; + name = Debug; + }; + 668249DC0FC0A30A0051560E /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + COPY_PHASE_STRIP = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + GCC_ENABLE_FIX_AND_CONTINUE = NO; + GCC_MODEL_TUNING = G5; + INSTALL_PATH = /usr/local/bin; + OTHER_LDFLAGS = "-lftdi"; + PREBINDING = NO; + PRODUCT_NAME = pinproctest; + ZERO_LINK = NO; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 1DEB91EB08733DB70010E9CD /* Build configuration list for PBXNativeTarget "libpinproc" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 1DEB91EC08733DB70010E9CD /* Debug */, + 1DEB91ED08733DB70010E9CD /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 1DEB91EF08733DB70010E9CD /* Build configuration list for PBXProject "libpinproc" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 1DEB91F008733DB70010E9CD /* Debug */, + 1DEB91F108733DB70010E9CD /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 668249DD0FC0A32A0051560E /* Build configuration list for PBXNativeTarget "pinproctest" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 668249DB0FC0A30A0051560E /* Debug */, + 668249DC0FC0A30A0051560E /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 08FB7793FE84155DC02AAC07 /* Project object */; +} diff --git a/src/PRDevice.cpp b/src/PRDevice.cpp new file mode 100644 index 0000000..95a24ee --- /dev/null +++ b/src/PRDevice.cpp @@ -0,0 +1,652 @@ +/* + * The MIT License + * Copyright (c) 2009 Gerry Stellenberg, Adam Preble + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ +/* + * PRDevice.cpp + * libpinproc + */ + +#include "PRDevice.h" + +PRDevice::PRDevice(PRMachineType machineType) : machineType(machineType), ftdiInitialized(false) +{ + Reset(); +} + +PRDevice::~PRDevice() +{ + Close(); +} + +PRDevice* PRDevice::Create(PRMachineType machineType) +{ + PRDevice *dev = new PRDevice(machineType); + + if (dev == NULL) + { + DEBUG(PRLog("Error allocating memory for P-ROC device\n")); + return NULL; + } + + if (!dev->Open()) + { + DEBUG(PRLog("Error opening P-ROC device.\n")); + delete dev; + return NULL; + } + + dev->Reset(); + + return dev; +} + +void PRDevice::Reset() +{ + bool defaultPolarity = machineType != kPRMachineWPC; + int i; + memset(&driverGlobalConfig, 0x00, sizeof(PRDriverGlobalConfig)); + for (i = 0; i < maxDrivers; i++) + { + PRDriverState *driver = &drivers[i]; + memset(driver, 0x00, sizeof(PRDriverState)); + driver->driverNum = i; + driver->polarity = defaultPolarity; + } + for (i = 0; i < maxDriverGroups; i++) + { + PRDriverGroupConfig *group = &driverGroups[i]; + memset(group, 0x00, sizeof(PRDriverGroupConfig)); + group->groupNum = i; + group->polarity = defaultPolarity; + } + for (i = 0; i < maxSwitchRules; i++) + { + PRSwitchRule *switchRule = &switchRules[i]; + memset(switchRule, 0x00, sizeof(PRSwitchRule)); + switchRule->switchNum = i; + switchRule->driver.polarity = defaultPolarity; + } + + unrequestedDataQueue.empty(); + requestedDataQueue.empty(); + num_collected_bytes = 0; + + // TODO: Assign defaults based on machineType. Some may have already been done above. +} + + +int PRDevice::GetEvents(PREvent *events, int maxEvents) +{ + SortReturningData(); + + // The unrequestedDataQueue only has unrequested switch event data. Pop + // events out 1 at a time, interpret them, and populate the outgoing list with them. + int i; + for (i = 0; (i < maxEvents) && !unrequestedDataQueue.empty(); i++) + { + uint32_t event_data = unrequestedDataQueue.front(); + unrequestedDataQueue.pop(); + + events[i].value = event_data & P_ROC_EVENT_SWITCH_NUM_MASK; + bool open = (event_data & P_ROC_EVENT_SWITCH_STATE_MASK) >> P_ROC_EVENT_SWITCH_STATE_SHIFT; + bool debounced = (event_data & P_ROC_EVENT_SWITCH_DEBOUNCED_MASK) >> P_ROC_EVENT_SWITCH_DEBOUNCED_SHIFT; + if (open) + events[i].type = debounced ? kPREventTypeSwitchOpenDebounced : kPREventTypeSwitchOpenNondebounced; + else + events[i].type = debounced ? kPREventTypeSwitchClosedDebounced : kPREventTypeSwitchOpenNondebounced; + } + return i; +} + + +PRResult PRDevice::DriverUpdateGlobalConfig(PRDriverGlobalConfig *driverGlobalConfig) +{ + const int burstWords = 2; + uint32_t burst[burstWords]; + int32_t rc; + + DEBUG(PRLog("Installing driver globals\n")); + + this->driverGlobalConfig = *driverGlobalConfig; + rc = CreateDriverUpdateGlobalConfigBurst(burst, driverGlobalConfig); + + DEBUG(PRLog("Words: %x %x\n", burst[0], burst[1])); + return WriteData(burst, burstWords); +} + +PRResult PRDevice::DriverGetGroupConfig(uint8_t groupNum, PRDriverGroupConfig *driverGroupConfig) +{ + *driverGroupConfig = driverGroups[groupNum]; + return kPRSuccess; +} + +PRResult PRDevice::DriverUpdateGroupConfig(PRDriverGroupConfig *driverGroupConfig) +{ + const int burstWords = 2; + uint32_t burst[burstWords]; + int32_t rc; + + driverGroups[driverGroupConfig->groupNum] = *driverGroupConfig; + DEBUG(PRLog("Installing driver group\n")); + rc = CreateDriverUpdateGroupConfigBurst(burst, driverGroupConfig); + + DEBUG(PRLog("Words: %x %x\n", burst[0], burst[1])); + return WriteData(burst, burstWords); +} + +PRResult PRDevice::DriverGetState(uint8_t driverNum, PRDriverState *driverState) +{ + *driverState = drivers[driverNum]; + return kPRSuccess; +} + +PRResult PRDevice::DriverUpdateState(PRDriverState *driverState) +{ + const int burstWords = 3; + uint32_t burst[burstWords]; + int32_t rc; + + DEBUG(PRLog("Updating driver #%d\n", driverState->driverNum)); + + if (driverState->polarity != drivers[driverState->driverNum].polarity && machineType != kPRMachineCustom) + { + DEBUG(PRLog("Refusing to update driver #%d; polarity differs on non-custom machine.\n", driverState->driverNum)); + return kPRFailure; + } + + drivers[driverState->driverNum] = *driverState; + + rc = CreateDriverUpdateBurst(burst, &drivers[driverState->driverNum]); + DEBUG(PRLog("Words: %x %x %x\n", burst[0], burst[1], burst[2])); + + return WriteData(burst, burstWords); +} + + +PRResult PRDevice::DriverDisable(uint16_t driverNum) +{ + PRDriverState driver; + DriverGetState(driverNum, &driver); + driver.state = 0; + driver.timeslots = 0; + driver.waitForFirstTimeSlot = false; + driver.outputDriveTime = 0; + driver.patterOnTime = 0; + driver.patterOffTime = 0; + driver.patterEnable = false; + return DriverUpdateState(&driver); +} + + +PRResult PRDevice::DriverPulse(uint16_t driverNum, int milliseconds) +{ + PRDriverState driver; + DriverGetState(driverNum, &driver); + driver.state = 1; + driver.timeslots = 0; + driver.waitForFirstTimeSlot = false; + driver.outputDriveTime = milliseconds; + driver.patterOnTime = 0; + driver.patterOffTime = 0; + driver.patterEnable = false; + return DriverUpdateState(&driver); +} + + +PRResult PRDevice::DriverSchedule(uint16_t driverNum, uint32_t schedule, uint8_t cycleSeconds, bool now) +{ + PRDriverState driver; + DriverGetState(driverNum, &driver); + driver.state = 1; + driver.timeslots = schedule; + driver.waitForFirstTimeSlot = !now; + driver.outputDriveTime = cycleSeconds; + driver.patterOnTime = 0; + driver.patterOffTime = 0; + driver.patterEnable = false; + return DriverUpdateState(&driver); +} + + +PRResult PRDevice::DriverPatter(uint16_t driverNum, uint16_t millisecondsOn, uint16_t millisecondsOff, uint16_t originalOnTime) +{ + PRDriverState driver; + DriverGetState(driverNum, &driver); + driver.state = originalOnTime != 0; + driver.timeslots = 0; + driver.waitForFirstTimeSlot = false; + driver.outputDriveTime = originalOnTime; + driver.patterOnTime = millisecondsOn; + driver.patterOffTime = millisecondsOff; + driver.patterEnable = true; + return DriverUpdateState(&driver); +} + + +PRResult PRDevice::SwitchesUpdateRules(PRSwitchRule *rules, int numRules) +{ + int32_t i,rc; + DEBUG(PRLog("SwitchesUpdateRules: numRules: %d\n", numRules)); + + // Iterate through the array of rules, install each in the P-ROC + for (i=0; i < numRules; i++) { + uint16_t switchNum = rules[i].switchNum; + switchRules[switchNum] = rules[i]; + PRSwitchRule *rule = &switchRules[switchNum]; + PRSwitchRule *nextRule = NULL; + + // See if this is the last item. If not, need to add a link to the current item + if (i != numRules - 1) { + nextRule = &rules[i+1]; + + // Link address is the switch number assigned to the next rule as that's where + // the next rule will be installed + rule->linkAddress = nextRule->switchNum; + rule->linkActive = true; + } + else { + rule->linkActive = false; + rule->linkAddress = 0; + } + + DEBUG(PRLog("Installing switch rule: switchNum: %d, eventType: %d\n link: %d, link address: %d\n", + rule->switchNum, rule->eventType, rule->linkActive, rule->linkAddress)); + + uint32_t rule_burst[4]; + rc = CreateSwitchesUpdateRulesBurst (rule_burst, rule); + + DEBUG(PRLog("words: %d:%d:%d:%d\n", rule_burst[0], rule_burst[1], rule_burst[2], rule_burst[3])); + + rc = WriteData(rule_burst, 4); + } + return rc; +} + + +int32_t PRDevice::DMDUpdateGlobalConfig(PRDMDGlobalConfig *dmdGlobalConfig) +{ + uint32_t rc; + uint32_t burst[10]; + + CreateDMDUpdateGlobalConfigBurst(burst, dmdGlobalConfig); + + DEBUG(PRLog("DMD config packet: ")); + for (int i=0; i<10; i++) { + DEBUG(PRLog("%d ", burst[i])); + } + DEBUG(PRLog("\n")); + + rc = WriteData(burst, 9); + return rc; +} + + +PRResult PRDevice::DMDDraw(uint8_t * dots, uint16_t columns, uint8_t rows, uint8_t numSubFrames) +{ + int32_t k; //i,x,y,j,k,m; + //uint8_t color; + uint16_t words_per_sub_frame = (columns*rows) / 32; + uint16_t words_per_frame = words_per_sub_frame * numSubFrames; + uint32_t dmd_command_buffer[1024]; + uint32_t * p_dmd_frame_buffer_words; + + p_dmd_frame_buffer_words = (uint32_t *)dots; + + dmd_command_buffer[0] = CreateBurstCommand(P_ROC_BUS_DMD_SELECT, P_ROC_DMD_DOT_TABLE_BASE_ADDR, words_per_frame); + for (k=0; k=0; j--) { + // for (x=7; x>=0; x--) { + // std::cout << ((dmd_frame_buffer[(y*32)+j] >> ((i*8)+x)) & 1); + // } + // } + // std::cout << ";\n"; + // } + // std::cout << "\n\n\n"; + //} + //} +} + + + +///////////////////////////////////////////////////////////////////////////////////////////// +// Device I/O + +PRResult PRDevice::Open() +{ + int32_t i=0; + PRResult rc; + struct ftdi_device_list *devlist, *curdev; + char manufacturer[128], description[128]; + uint32_t temp_word; + + ftdiInitialized = false; + + // Open the FTDI device + if (ftdi_init(&ftdic) != 0) + { + DEBUG(PRLog("Failed to initialize FTDI.\n")); + return kPRFailure; + } + + // Find all FTDI devices + // This is very basic and really only expects to see 1 device. It needs to be + // smarter. At the very least, it should check some register on the P-ROC versus + // an input parameter to ensure the software is set up for the same architecture as + // the P-ROC (Stern vs WPC). Otherwise, it's possible to drive the coils the wrong + // polarity and blow fuses or fry transistors and all other sorts of badness. + + // We first enumerate all of the devices: + int numDevices = ftdi_usb_find_all(&ftdic, &devlist, FTDI_VENDOR_ID, FTDI_FT245RL_PRODUCT_ID); + if (numDevices < 0) { + DEBUG(PRLog("ftdi_usb_find_all failed: %d: %s\n", numDevices, ftdi_get_error_string(&ftdic))); + ftdi_deinit(&ftdic); + return kPRFailure; + } + else { + DEBUG(PRLog("Number of FTDI devices found: %d\n", numDevices)); + + for (curdev = devlist; curdev != NULL; i++) { + DEBUG(PRLog("Checking device %d\n", i)); + if ((rc = (int32_t)ftdi_usb_get_strings(&ftdic, curdev->dev, manufacturer, 128, description, 128, NULL, 0)) < 0) { + DEBUG(PRLog(" ftdi_usb_get_strings failed: %d: %s\n", rc, ftdi_get_error_string(&ftdic))); + } + else { + DEBUG(PRLog(" Device #%d:\n", i)); + DEBUG(PRLog(" Manufacturer: %s\n", manufacturer)); + DEBUG(PRLog(" Description: %s\n", description)); + } + curdev = curdev->next; + } + + } + + // Don't need the device list anymore + ftdi_list_free (&devlist); + // Did previous logic leave ftdic clean? Probably + // Need to de-init and re-init before opening usb? Doubtful. + //ftdi_deinit(&ftdic); + //ftdi_init(&ftdic); + + + if ((rc = (int32_t)ftdi_usb_open(&ftdic, FTDI_VENDOR_ID, FTDI_FT245RL_PRODUCT_ID)) < 0) + { + DEBUG(PRLog("ERROR: Unable to open ftdi device: %d: %s\n", rc, ftdi_get_error_string(&ftdic))); + return kPRFailure; + } + else + { + rc = kPRSuccess; + if (ftdic.type == TYPE_R) { + uint32_t chipid; + ftdi_read_chipid(&ftdic,&chipid); + DEBUG(PRLog("FTDI chip_id = 0x%x\n", chipid)); + + // Try to verify the P-ROC IS in the FPGA before initializing the FPGA's FTDI interface + // just in case it was already initialized from a previous application execution. + DEBUG(PRLog("Verifying P-ROC ID: \n")); + if (VerifyChipID() == kPRFailure) { + // Since the FPGA didn't appear to be responding properly, send the FPGA's FTDI + // initialization sequence. This is a set of bytes the FPGA is waiting to receive + // before it allows access deeper into the chip. This keeps garbage from getting + // in and wreaking havoc before software is up and running. + DEBUG(PRLog("Initializing P-ROC...\n")); + rc = FlushReadBuffer(); + temp_word = P_ROC_INIT_PATTERN_A; + rc = WriteData(&temp_word, 1); + temp_word = P_ROC_INIT_PATTERN_B; + rc = WriteData(&temp_word, 1); + rc = VerifyChipID(); + } + else + { + DEBUG(PRLog("Failed to verify chip ID.")); + rc = kPRFailure; + } + } + } + + if (rc == kPRSuccess) + ftdiInitialized = true; + + return rc; +} + +PRResult PRDevice::Close() +{ + // TODO: Add protection against closing a not-open ftdic. + if (ftdiInitialized) + { + ftdi_usb_close(&ftdic); + ftdi_deinit(&ftdic); + } + return kPRSuccess; +} + +PRResult PRDevice::VerifyChipID() +{ + PRResult rc; + const int bufferWords = 5; + uint32_t buffer[bufferWords]; + //uint32_t temp_word; + uint32_t max_count; + + //std::cout << "Requesting FPGA Chip ID: "; + rc = RequestData(P_ROC_MANAGER_SELECT, P_ROC_REG_CHIP_ID_ADDR, 4); + + max_count = 0; + //std::cout << "Waiting for read data "; + while (num_collected_bytes < (bufferWords*4) && max_count < 10) { + sleep(.01); + //std::cout << ". "; + rc = CollectReadData(); + max_count++; + } + //std::cout << "\n"; + + if (max_count != 10) { + int wordsRead = ReadData(buffer, bufferWords); + + if (wordsRead == 5) { + //std::cout << rc << " words read. \n" + DEBUG(PRLog("FPGA Chip ID: 0x%x\n", buffer[1])); + DEBUG(PRLog("FPGA Chip Version/Rev: %d.%d\n", buffer[2] >> 16, buffer[2] & 0xffff)); + DEBUG(PRLog("Watchdog Settings: 0x%x\n", buffer[3])); + DEBUG(PRLog("Switches: 0x%x\n", buffer[4])); + rc = kPRSuccess; + } + else { + DEBUG(PRLog("Error reading Chip IP and Version. Incorrect number of bytes received from read_data().\n")); + rc = kPRFailure; + } + } + else { + DEBUG(PRLog("Unable to read Chip ID - P-ROC not yet initialized.\n")); + rc = kPRFailure; + } + return (rc); +} + +PRResult PRDevice::RequestData(uint32_t module_select, uint32_t start_addr, int32_t num_words) +{ + uint32_t requestWord = CreateRegRequestWord(module_select, start_addr, num_words); + return WriteData(&requestWord, 1); +} + +PRResult PRDevice::WriteData(uint32_t * words, int32_t numWords) +{ + int32_t j,k; +// int32_t item; + + if (numWords == 0) + return kPRSuccess; + + // The 32-bit words coming in are in the same byte order they need to be in the P-ROC. + // However, due to Intel endian-ness, simply casting the words to 4 bytes changes the + // byte order. So, the conversion to bytes is done here manually to preserve the byte + // order. Might want to add a parameter for endian-ness at some point to make it + // work on big endian architectures. + for (j = 0; j < numWords; j++) { + uint32_t temp_word = words[j]; + for (k = 3; k >= 0; k--) + { + wr_buffer[(j*4)+k] = (uint8_t)(temp_word & 0x000000ff); + temp_word = temp_word >> 8; + } +// for (k=0; k<4; k++) +// { +// item = wr_buffer[(j*4)+k]; +// } + } + + int bytesToWrite = numWords * 4; + int bytesWritten = (int32_t)ftdi_write_data(&ftdic, wr_buffer, bytesToWrite); + + if (bytesWritten != bytesToWrite) + { + DEBUG(PRLog("Error in WriteData: wrote %d of %d bytes\n", bytesWritten, bytesToWrite)); + return kPRFailure; + } + else + { + return kPRSuccess; + } +} + + +int32_t PRDevice::ReadData(uint32_t *buffer, int32_t num_words) +{ + int32_t rc,i,j; + + // Just like in the write_data method, the bytes are ordered here manually to put + // them in the right order. They are pulled from the collected_bytes_fifo 1 at a time + // and stuffed into 32-bit words, high byte to low byte. + if ((num_words * 4) <= num_collected_bytes) { + for (j=0; j 0) + { + DEBUG(PRLog("Collected bytes: %d\n", rc)); + } + return (rc); +} + +PRResult PRDevice::SortReturningData() +{ + uint32_t num_bytes, num_words, rc; + uint32_t rd_buffer[512]; + + num_bytes = CollectReadData(); + num_words = num_collected_bytes/4; + + while (num_words >= 2) { + rc = ReadData(rd_buffer, 1); + DEBUG(PRLog("New returning word: 0x%x\n", rd_buffer[0])); + + switch ( (rd_buffer[0] & P_ROC_COMMAND_MASK) >> P_ROC_COMMAND_SHIFT) + { + // Must be a bug in the P-ROC. Unrequested packets are returning looking + // like requested packets. Commenting out requested packets for now. + case P_ROC_REQUESTED_DATA: { + int bytesRead = ReadData(rd_buffer, + (rd_buffer[0] & P_ROC_HEADER_LENGTH_MASK) >> + P_ROC_HEADER_LENGTH_SHIFT); + for (int i = 0; i < bytesRead; i++) + requestedDataQueue.push(rd_buffer[i]); + break; + } + case P_ROC_UNREQUESTED_DATA: { + ReadData(rd_buffer,1); + DEBUG(PRLog("Pushing onto unreq Q 0x%x\n", rd_buffer[0])); + unrequestedDataQueue.push(rd_buffer[0]); + break; + } + } + num_words = num_collected_bytes/4; + } + return kPRSuccess; +} diff --git a/src/PRDevice.h b/src/PRDevice.h new file mode 100644 index 0000000..07f8fbf --- /dev/null +++ b/src/PRDevice.h @@ -0,0 +1,143 @@ +/* + * The MIT License + * Copyright (c) 2009 Gerry Stellenberg, Adam Preble + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ +/* + * PRDevice.h + * libpinproc + */ + +#include "../include/pinproc.h" +#include "PRHardware.h" +#include +#include + +using namespace std; + +#define maxDriverGroups (26) +#define maxDrivers (256) +#define maxSwitchRules (256) + +#ifdef NDEBUG +# define DEBUG(block) +#else +# define DEBUG(block) block +#endif +extern void PRLog(const char *format, ...); + +class PRDevice +{ +public: + static PRDevice *Create(PRMachineType machineType); + ~PRDevice(); +protected: + PRDevice(PRMachineType machineType); + +public: + // public libpinproc API: + int GetEvents(PREvent *events, int maxEvents); + + PRResult DriverUpdateGlobalConfig(PRDriverGlobalConfig *driverGlobalConfig); + PRResult DriverGetGroupConfig(uint8_t groupNum, PRDriverGroupConfig *driverGroupConfig); + PRResult DriverUpdateGroupConfig(PRDriverGroupConfig *driverGroupConfig); + PRResult DriverGetState(uint8_t driverNum, PRDriverState *driverState); + PRResult DriverUpdateState(PRDriverState *driverState); + + PRResult DriverDisable(uint16_t driverNum); + PRResult DriverPulse(uint16_t driverNum, int milliseconds); + PRResult DriverSchedule(uint16_t driverNum, uint32_t schedule, uint8_t cycleSeconds, bool now); + PRResult DriverPatter(uint16_t driverNum, uint16_t millisecondsOn, uint16_t millisecondsOff, uint16_t originalOnTime); + + PRResult SwitchesUpdateRules(PRSwitchRule *rules, int numRules); + + PRResult DMDUpdateGlobalConfig(PRDMDGlobalConfig *dmdGlobalConfig); + PRResult DMDDraw(uint8_t * dots, uint16_t columns, uint8_t rows, uint8_t numSubFrames); + +protected: + + // Device I/O + + PRResult Open(); + PRResult Close(); + + PRResult VerifyChipID(); + + // Raw write and read methods + + /** Writes data to P-ROC. + * Returns #kPFailure if the number of words read does not match the number requested. + */ + PRResult WriteData(uint32_t * buffer, int32_t numWords); + + /** + * Reads data from the buffer that was previously collected by CollectReadData(). + * Returns the number of bytes read. + */ + int32_t ReadData(uint32_t *buffer, int32_t maxWords); + + // Collection of methods to get data returning from the P-ROC + /** + * Request a block of data from the P-ROC. + */ + PRResult RequestData(uint32_t module_select, uint32_t start_addr, int32_t num_words); + /** + * Actually reads the data off of the FTDI chip. + * This is called by SortReturningData() in order to get some data to process. + */ + int32_t CollectReadData(); + /** + * Processes data into unrequestedDataQueue and requestedDataQueue. + * Calls CollectReadData() to obtain the data and then uses ReadData() to read it out. + */ + PRResult SortReturningData(); + /** + * Empties out the read buffer. + * Calls CollectReadData() and then ReadData() until it's empty. + */ + PRResult FlushReadBuffer(); + + queue unrequestedDataQueue; /**< Queue of words received from the device that were not requested via RequestData(). Usually switch events. */ + queue requestedDataQueue; /**< Queue of words received from the device as the result of a call to RequestData(). */ + + bool ftdiInitialized; + ftdi_context ftdic; + + uint8_t collected_bytes_fifo[FTDI_BUFFER_SIZE]; + int32_t collected_bytes_rd_addr; + int32_t collected_bytes_wr_addr; + int32_t num_collected_bytes; + + uint8_t wr_buffer[16384]; + uint8_t collect_buffer[FTDI_BUFFER_SIZE]; + + + // Local Device State + void Reset(); + PRMachineType machineType; + PRDriverGlobalConfig driverGlobalConfig; + PRDriverGroupConfig driverGroups[maxDriverGroups]; + PRDriverState drivers[maxDrivers]; + PRSwitchRule switchRules[maxSwitchRules]; + +}; \ No newline at end of file diff --git a/src/PRHardware.cpp b/src/PRHardware.cpp new file mode 100644 index 0000000..d3edcc4 --- /dev/null +++ b/src/PRHardware.cpp @@ -0,0 +1,171 @@ +/* + * The MIT License + * Copyright (c) 2009 Gerry Stellenberg, Adam Preble + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ +/* + * PRHardware.cpp + * libpinproc + */ + + +#include "PRHardware.h" + + +uint32_t CreateRegRequestWord( uint32_t select, uint32_t addr, uint32_t num_words ) { + return ( (P_ROC_READ << P_ROC_COMMAND_SHIFT) | + (num_words << P_ROC_HEADER_LENGTH_SHIFT) | + (select << P_ROC_MODULE_SELECT_SHIFT) | + (addr << P_ROC_ADDR_SHIFT) ); +}; + + +uint32_t CreateBurstCommand ( uint32_t select, uint32_t addr, uint32_t num_words ) { + return ( (P_ROC_WRITE << P_ROC_COMMAND_SHIFT) | + (num_words << P_ROC_HEADER_LENGTH_SHIFT) | + (select << P_ROC_MODULE_SELECT_SHIFT) | + (addr << P_ROC_ADDR_SHIFT) ); +} + +int32_t CreateDriverUpdateGlobalConfigBurst ( uint32_t * burst, PRDriverGlobalConfig *driver_globals) { + uint32_t addr; + + addr = 0; + addr = (P_ROC_DRIVER_CTRL_REG_DECODE << P_ROC_DRIVER_CTRL_DECODE_SHIFT); + + burst[0] = CreateBurstCommand (P_ROC_BUS_DRIVER_CTRL_SELECT, addr, 1 ); + burst[1] = ( (driver_globals->enableOutputs << + P_ROC_DRIVER_GLOBAL_ENABLE_DIRECT_OUTPUTS_SHIFT) | + (driver_globals->globalPolarity << + P_ROC_DRIVER_GLOBAL_GLOBAL_POLARITY_SHIFT) | + (driver_globals->useClear << + P_ROC_DRIVER_GLOBAL_USE_CLEAR_SHIFT) | + (driver_globals->strobeStartSelect << + P_ROC_DRIVER_GLOBAL_STROBE_START_SELECT_SHIFT) | + (driver_globals->startStrobeTime << + P_ROC_DRIVER_GLOBAL_START_STROBE_TIME_SHIFT) | + (driver_globals->matrixRowEnableIndex1 << + P_ROC_DRIVER_GLOBAL_MATRIX_ROW_ENABLE_INDEX_1_SHIFT) | + (driver_globals->matrixRowEnableIndex0 << + P_ROC_DRIVER_GLOBAL_MATRIX_ROW_ENABLE_INDEX_0_SHIFT) | + (driver_globals->activeLowMatrixRows << + P_ROC_DRIVER_GLOBAL_ACTIVE_LOW_MATRIX_ROWS_SHIFT) | + (driver_globals->encodeEnables << + P_ROC_DRIVER_GLOBAL_ENCODE_ENABLES_SHIFT) | + (driver_globals->tickleWatchdog << + P_ROC_DRIVER_GLOBAL_TICKLE_WATCHDOG_SHIFT) ); + return kPRSuccess; +} + +int32_t CreateDriverUpdateGroupConfigBurst ( uint32_t * burst, PRDriverGroupConfig *driver_group) { + uint32_t addr; + + addr = 0; + addr = (P_ROC_DRIVER_CTRL_REG_DECODE << P_ROC_DRIVER_CTRL_DECODE_SHIFT) | + driver_group->groupNum; + + burst[0] = CreateBurstCommand (P_ROC_BUS_DRIVER_CTRL_SELECT, addr, 1 ); + burst[1] = ( (driver_group->slowTime << + P_ROC_DRIVER_GROUP_SLOW_TIME_SHIFT) | + (driver_group->disableStrobeAfter << + P_ROC_DRIVER_GROUP_DISABLE_STROBE_AFTER_SHIFT) | + (driver_group->enableIndex << + P_ROC_DRIVER_GROUP_ENABLE_INDEX_SHIFT) | + (driver_group->rowActivateIndex << + P_ROC_DRIVER_GROUP_ROW_ACTIVATE_INDEX_SHIFT) | + (driver_group->rowEnableSelect << + P_ROC_DRIVER_GROUP_ROW_ENABLE_SELECT_SHIFT) | + (driver_group->matrixed << + P_ROC_DRIVER_GROUP_MATRIXED_SHIFT) | + (driver_group->polarity << + P_ROC_DRIVER_GROUP_POLARITY_SHIFT) | + (driver_group->active << + P_ROC_DRIVER_GROUP_ACTIVE_SHIFT) ); + return kPRSuccess; +} + +int32_t CreateDriverUpdateBurst ( uint32_t * burst, PRDriverState *driver) { + uint32_t addr; + + addr = 0; + addr = (P_ROC_DRIVER_CONFIG_TABLE_DECODE << P_ROC_DRIVER_CTRL_DECODE_SHIFT) | + (driver->driverNum << P_ROC_DRIVER_CONFIG_TABLE_DRIVER_NUM_SHIFT); + + burst[0] = CreateBurstCommand (P_ROC_BUS_DRIVER_CTRL_SELECT, addr, 2 ); + burst[1] = ( (driver->outputDriveTime << P_ROC_DRIVER_CONFIG_OUTPUT_DRIVE_TIME_SHIFT) | + (driver->polarity << P_ROC_DRIVER_CONFIG_POLARITY_SHIFT) | + (driver->state << P_ROC_DRIVER_CONFIG_STATE_SHIFT) | + (1 << P_ROC_DRIVER_CONFIG_UPDATE_SHIFT) | + (driver->waitForFirstTimeSlot << P_ROC_DRIVER_CONFIG_WAIT_4_1ST_SLOT_SHIFT) | + (driver->timeslots << P_ROC_DRIVER_CONFIG_TIMESLOT_SHIFT) ); + burst[2] = (driver->timeslots >> P_ROC_DRIVER_CONFIG_TIMESLOT_SHIFT) | + (driver->patterOnTime << P_ROC_DRIVER_CONFIG_PATTER_ON_TIME_SHIFT) | + (driver->patterOffTime << P_ROC_DRIVER_CONFIG_PATTER_OFF_TIME_SHIFT) | + (driver->patterEnable << P_ROC_DRIVER_CONFIG_PATTER_ENABLE_SHIFT); + return kPRSuccess; +} + +int32_t CreateSwitchesUpdateRulesBurst ( uint32_t * burst, PRSwitchRule *rule_record) { + uint32_t addr; + uint32_t driver_command[3]; + + CreateDriverUpdateBurst ( driver_command, &(rule_record->driver)); + + uint32_t debounce = (rule_record->eventType == kPREventTypeSwitchOpenDebounced) || (rule_record->eventType == kPREventTypeSwitchClosedDebounced) ? 1 : 0; + uint32_t state = (rule_record->eventType == kPREventTypeSwitchOpenDebounced) || (rule_record->eventType == kPREventTypeSwitchOpenNondebounced) ? 1 : 0; + + addr = ( (debounce << P_ROC_SWITCH_RULE_ADDR_DEBOUNCE_SHIFT) | + (state << P_ROC_SWITCH_RULE_ADDR_STATE_SHIFT) | + (rule_record->switchNum << P_ROC_SWITCH_RULE_ADDR_SWITCH_NUM_SHIFT) ); + + burst[0] = CreateBurstCommand (P_ROC_BUS_STATE_CHANGE_PROC_SELECT, addr, 3 ); + burst[1] = driver_command[1]; + burst[2] = driver_command[2]; + + burst[3] = (rule_record->changeOutput << P_ROC_SWITCH_RULE_CHANGE_OUTPUT_SHIFT) | + (rule_record->driver.driverNum << P_ROC_SWITCH_RULE_DRIVER_NUM_SHIFT) | + (rule_record->linkActive << P_ROC_SWITCH_RULE_LINK_ACTIVE_SHIFT) | + (rule_record->linkAddress << P_ROC_SWITCH_RULE_LINK_ADDRESS_SHIFT) | + (rule_record->notifyHost << P_ROC_SWITCH_RULE_NOTIFY_HOST_SHIFT); + return kPRSuccess; + +} + +int32_t CreateDMDUpdateGlobalConfigBurst ( uint32_t * burst, PRDMDConfig *dmd_config) +{ + uint32_t addr; + uint32_t i; + + addr = 8; + burst[0] = CreateBurstCommand (P_ROC_BUS_DMD_SELECT, addr, 8 ); + + for (i=0; i<8; i++) { + burst[i+1] = 0; + burst[i+1] = (dmd_config->rclkLowCycles[i] << P_ROC_DMD_RCLK_LOW_CYCLES_SHIFT) | + (dmd_config->latchHighCycles[i] << P_ROC_DMD_LATCH_HIGH_CYCLES_SHIFT) | + (dmd_config->deHighCycles[i] << P_ROC_DMD_DE_HIGH_CYCLES_SHIFT) | + (dmd_config->dotclkHalfPeriod[i] << P_ROC_DMD_DOTCLK_HALF_PERIOD_SHIFT); + } + return kPRSuccess; +} + diff --git a/src/PRHardware.h b/src/PRHardware.h new file mode 100644 index 0000000..e039ac7 --- /dev/null +++ b/src/PRHardware.h @@ -0,0 +1,153 @@ +/* + * The MIT License + * Copyright (c) 2009 Gerry Stellenberg, Adam Preble + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ +#ifndef _PROC_HARDWARE_H_ +#define _PROC_HARDWARE_H_ + +#include +#include "../include/pinproc.h" + +const int32_t FTDI_VENDOR_ID = 0x0403; +const int32_t FTDI_FT245RL_PRODUCT_ID = 0x6001; + +const int32_t FTDI_BUFFER_SIZE = 2048; +const uint32_t P_ROC_INIT_PATTERN_A = 0x801F1122; +const uint32_t P_ROC_INIT_PATTERN_B = 0x345678AB; +const uint32_t P_ROC_CHIP_ID = 0xFEEDBEEF; + +const uint32_t P_ROC_ADDR_MASK = 0x000FFFFF; +const uint32_t P_ROC_HEADER_LENGTH_MASK = 0x7FF00000; +const uint32_t P_ROC_COMMAND_MASK = 0x80000000; + +const uint32_t P_ROC_ADDR_SHIFT = 0; +const uint32_t P_ROC_HEADER_LENGTH_SHIFT = 20; +const uint32_t P_ROC_COMMAND_SHIFT = 31; + +const uint32_t P_ROC_READ = 0; +const uint32_t P_ROC_WRITE = 1; +const uint32_t P_ROC_REQUESTED_DATA = 0; +const uint32_t P_ROC_UNREQUESTED_DATA = 1; + +const uint32_t P_ROC_REG_ADDR_MASK = 0x0000FFFF; +const uint32_t P_ROC_MODULE_SELECT_MASK = 0x000F0000; + +const uint32_t P_ROC_REG_ADDR_SHIFT = 0; +const uint32_t P_ROC_MODULE_SELECT_SHIFT = 16; + +const uint32_t P_ROC_MANAGER_SELECT = 0; +const uint32_t P_ROC_BUS_MASTER_SELECT = 1; +const uint32_t P_ROC_BUS_SWITCH_CTRL_SELECT = 2; +const uint32_t P_ROC_BUS_DRIVER_CTRL_SELECT = 3; +const uint32_t P_ROC_BUS_STATE_CHANGE_PROC_SELECT = 4; +const uint32_t P_ROC_BUS_DMD_SELECT = 5; +const uint32_t P_ROC_BUS_UNASSOCIATED_SELECT = 15; + +const uint32_t P_ROC_REG_CHIP_ID_ADDR = 0; +const uint32_t P_ROC_REG_VERSION_ADDR = 1; +const uint32_t P_ROC_REG_WATCHDOG_ADDR = 2; +const uint32_t P_ROC_REG_DIPSWITCH_ADDR = 3; + +const uint32_t P_ROC_EVENT_SWITCH_NUM_MASK = 0xFF; +const uint32_t P_ROC_EVENT_SWITCH_STATE_MASK = 0x100; +const uint32_t P_ROC_EVENT_SWITCH_STATE_SHIFT = 8; + +const uint32_t P_ROC_EVENT_SWITCH_DEBOUNCED_MASK = 0x200; +const uint32_t P_ROC_EVENT_SWITCH_DEBOUNCED_SHIFT = 9; + +const uint32_t P_ROC_DRIVER_CTRL_DECODE_SHIFT = 10; +const uint32_t P_ROC_DRIVER_CTRL_REG_DECODE = 0; +const uint32_t P_ROC_DRIVER_CONFIG_TABLE_DECODE = 1; +const uint32_t P_ROC_DRIVER_STATE_TABLE_DECODE = 2; +const uint32_t P_ROC_DRIVER_CATCHALL_DECODE = 3; + +const uint32_t P_ROC_DRIVER_GLOBAL_ENABLE_DIRECT_OUTPUTS_SHIFT = 31; +const uint32_t P_ROC_DRIVER_GLOBAL_GLOBAL_POLARITY_SHIFT = 30; +const uint32_t P_ROC_DRIVER_GLOBAL_USE_CLEAR_SHIFT = 28; +const uint32_t P_ROC_DRIVER_GLOBAL_STROBE_START_SELECT_SHIFT = 27; +const uint32_t P_ROC_DRIVER_GLOBAL_START_STROBE_TIME_SHIFT = 20; +const uint32_t P_ROC_DRIVER_GLOBAL_START_STROBE_TIME_MASK = 0x07F00000; +const uint32_t P_ROC_DRIVER_GLOBAL_MATRIX_ROW_ENABLE_INDEX_1_SHIFT = 16; +const uint32_t P_ROC_DRIVER_GLOBAL_MATRIX_ROW_ENABLE_INDEX_1_MASK = 0x000F0000; +const uint32_t P_ROC_DRIVER_GLOBAL_MATRIX_ROW_ENABLE_INDEX_0_SHIFT = 12; +const uint32_t P_ROC_DRIVER_GLOBAL_MATRIX_ROW_ENABLE_INDEX_0_MASK = 0x0000F000; +const uint32_t P_ROC_DRIVER_GLOBAL_ACTIVE_LOW_MATRIX_ROWS_SHIFT = 11; +const uint32_t P_ROC_DRIVER_GLOBAL_ENCODE_ENABLES_SHIFT = 10; +const uint32_t P_ROC_DRIVER_GLOBAL_TICKLE_WATCHDOG_SHIFT = 9; + +const uint32_t P_ROC_DRIVER_GROUP_SLOW_TIME_SHIFT = 12; +const uint32_t P_ROC_DRIVER_GROUP_DISABLE_STROBE_AFTER_SHIFT = 11; +const uint32_t P_ROC_DRIVER_GROUP_ENABLE_INDEX_SHIFT = 7; +const uint32_t P_ROC_DRIVER_GROUP_ROW_ACTIVATE_INDEX_SHIFT = 4; +const uint32_t P_ROC_DRIVER_GROUP_ROW_ENABLE_SELECT_SHIFT = 3; +const uint32_t P_ROC_DRIVER_GROUP_MATRIXED_SHIFT = 2; +const uint32_t P_ROC_DRIVER_GROUP_POLARITY_SHIFT = 1; +const uint32_t P_ROC_DRIVER_GROUP_ACTIVE_SHIFT = 0; + +const uint32_t P_ROC_DRIVER_CONFIG_OUTPUT_DRIVE_TIME_SHIFT = 0; +const uint32_t P_ROC_DRIVER_CONFIG_POLARITY_SHIFT = 8; +const uint32_t P_ROC_DRIVER_CONFIG_STATE_SHIFT = 9; +const uint32_t P_ROC_DRIVER_CONFIG_UPDATE_SHIFT = 10; +const uint32_t P_ROC_DRIVER_CONFIG_WAIT_4_1ST_SLOT_SHIFT = 11; +const uint32_t P_ROC_DRIVER_CONFIG_TIMESLOT_SHIFT = 16; +const uint32_t P_ROC_DRIVER_CONFIG_PATTER_ON_TIME_SHIFT = 16; +const uint32_t P_ROC_DRIVER_CONFIG_PATTER_OFF_TIME_SHIFT = 23; +const uint32_t P_ROC_DRIVER_CONFIG_PATTER_ENABLE_SHIFT = 30; + +const uint32_t P_ROC_DRIVER_CONFIG_TABLE_DRIVER_NUM_SHIFT = 1; + +const uint32_t P_ROC_SWITCH_RULE_ADDR_DEBOUNCE_SHIFT = 11; +const uint32_t P_ROC_SWITCH_RULE_ADDR_STATE_SHIFT = 10; +const uint32_t P_ROC_SWITCH_RULE_ADDR_SWITCH_NUM_SHIFT = 2; + +const uint32_t P_ROC_SWITCH_RULE_NOTIFY_HOST_SHIFT = 23; +const uint32_t P_ROC_SWITCH_RULE_LINK_ACTIVE_SHIFT = 10; +const uint32_t P_ROC_SWITCH_RULE_LINK_ADDRESS_SHIFT = 11; +const uint32_t P_ROC_SWITCH_RULE_CHANGE_OUTPUT_SHIFT = 9; +const uint32_t P_ROC_SWITCH_RULE_DRIVER_NUM_SHIFT = 0; + +const uint32_t P_ROC_DMD_NUM_COLUMNS_SHIFT = 0; +const uint32_t P_ROC_DMD_NUM_ROWS_SHIFT = 8; +const uint32_t P_ROC_DMD_NUM_SHADES_SHIFT = 16; +const uint32_t P_ROC_DMD_CYCLES_PER_ROW_SHIFT = 21; +const uint32_t P_ROC_DMD_ENABLE_SHIFT = 31; + +const uint32_t P_ROC_DMD_DOTCLK_HALF_PERIOD_SHIFT = 0; +const uint32_t P_ROC_DMD_DE_HIGH_CYCLES_SHIFT = 8; +const uint32_t P_ROC_DMD_LATCH_HIGH_CYCLES_SHIFT = 16; +const uint32_t P_ROC_DMD_RCLK_LOW_CYCLES_SHIFT = 24; + +const uint32_t P_ROC_DMD_DOT_TABLE_BASE_ADDR = 0x1000; + + + +uint32_t CreateRegRequestWord( uint32_t select, uint32_t addr, uint32_t num_words); +uint32_t CreateBurstCommand ( uint32_t select, uint32_t addr, uint32_t num_words); +int32_t CreateDriverUpdateGlobalConfigBurst ( uint32_t * burst, PRDriverGlobalConfig *driver_globals); +int32_t CreateDriverUpdateGroupConfigBurst ( uint32_t * burst, PRDriverGroupConfig *driver_group); +int32_t CreateDriverUpdateBurst ( uint32_t * burst, PRDriverState *driver); +int32_t CreateSwitchesUpdateRulesBurst ( uint32_t * burst, PRSwitchRule *rule_record); +int32_t CreateDMDUpdateGlobalConfigBurst ( uint32_t * burst, PRDMDConfig *dmd_config); + +#endif // _PROC_HARDWARE_H_ diff --git a/src/pinproc.cpp b/src/pinproc.cpp new file mode 100644 index 0000000..86ed25c --- /dev/null +++ b/src/pinproc.cpp @@ -0,0 +1,142 @@ +/* + * The MIT License + * Copyright (c) 2009 Gerry Stellenberg, Adam Preble + * + * Permission is hereby granted, free of charge, to any person + * obtaining a copy of this software and associated documentation + * files (the "Software"), to deal in the Software without + * restriction, including without limitation the rights to use, + * copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following + * conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + */ +/* + * pinproc.cpp + * libpinproc + */ + +#include "../include/pinproc.h" +#include "PRDevice.h" + +typedef void (*PRLogCallback)(const char *text); + +PRLogCallback logCallback = NULL; + +void PRLog(const char *format, ...) +{ + const int maxLogLineLength = 1024; + char line[maxLogLineLength]; + va_list ap; + va_start(ap, format); + vsnprintf(line, maxLogLineLength, format, ap); + if (logCallback) + logCallback(line); + else + fprintf(stderr, line); +} + +void PRLogSetCallback(PRLogCallback callback) +{ + logCallback = callback; +} + + +#define handleAsDevice ((PRDevice*)handle) + +/** Create a new P-ROC device handle. Only one handle per device may be created. This handle must be destroyed with PRDelete() when it is no longer needed. */ +PR_EXPORT PRHandle PRCreate(PRMachineType machineType) +{ + PRDevice *device = PRDevice::Create(machineType); + if (device == NULL) + return kPRHandleInvalid; + else + return device; +} +/** Destroys an existing P-ROC device handle. */ +PR_EXPORT void PRDelete(PRHandle handle) +{ + if (handle != kPRHandleInvalid) + delete (PRDevice*)handle; +} + + +// Events + +/** Get all of the available events that have been received. */ +PR_EXPORT int PRGetEvents(PRHandle handle, PREvent *eventsOut, int maxEvents) +{ + return handleAsDevice->GetEvents(eventsOut, maxEvents); +} + + +// Drivers +PR_EXPORT PRResult PRDriverUpdateGlobalConfig(PRHandle handle, PRDriverGlobalConfig *driverGlobalConfig) +{ + return handleAsDevice->DriverUpdateGlobalConfig(driverGlobalConfig); +} +PR_EXPORT PRResult PRDriverGetGroupConfig(PRHandle handle, uint8_t groupNum, PRDriverGroupConfig *driverGroupConfig) +{ + return handleAsDevice->DriverGetGroupConfig(groupNum, driverGroupConfig); +} +PR_EXPORT PRResult PRDriverUpdateGroupConfig(PRHandle handle, PRDriverGroupConfig *driverGroupConfig) +{ + return handleAsDevice->DriverUpdateGroupConfig(driverGroupConfig); +} +PR_EXPORT PRResult PRDriverGetState(PRHandle handle, uint8_t driverNum, PRDriverState *driverState) +{ + return handleAsDevice->DriverGetState(driverNum, driverState); +} +PR_EXPORT PRResult PRDriverUpdateState(PRHandle handle, PRDriverState *driverState) +{ + return handleAsDevice->DriverUpdateState(driverState); +} + +// Driver Helper functions: +PR_EXPORT PRResult PRDriverDisable(PRHandle handle, uint16_t driverNum) +{ + return handleAsDevice->DriverDisable(driverNum); +} +PR_EXPORT PRResult PRDriverPulse(PRHandle handle, uint16_t driverNum, int milliseconds) +{ + return handleAsDevice->DriverPulse(driverNum, milliseconds); +} +PR_EXPORT PRResult PRDriverSchedule(PRHandle handle, uint16_t driverNum, uint32_t schedule, uint8_t cycleSeconds, bool_t now) +{ + return handleAsDevice->DriverSchedule(driverNum, schedule, cycleSeconds, now); +} +PR_EXPORT PRResult PRDriverPatter(PRHandle handle, uint16_t driverNum, uint16_t millisecondsOn, uint16_t millisecondsOff, uint16_t originalOnTime) +{ + return handleAsDevice->DriverPatter(driverNum, millisecondsOn, millisecondsOff, originalOnTime); +} + + + +// Switches + +PR_EXPORT PRResult PRSwitchesUpdateRules(PRHandle handle, PRSwitchRule *rules, int numRules) +{ + return handleAsDevice->SwitchesUpdateRules(rules, numRules); +} + +PR_EXPORT int32_t PRDMDUpdateGlobalConfig(PRHandle handle, PRDMDGlobalConfig *dmdGlobalConfig) +{ + return handleAsDevice->DMDUpdateGlobalConfig(dmdGlobalConfig); +} +PR_EXPORT PRResult PRDMDDraw(PRHandle handle, uint8_t * dots, uint16_t columns, uint8_t rows, uint8_t numSubFrames) +{ + return handleAsDevice->DMDDraw(dots, columns, rows, numSubFrames); +} +