rm -f $(OBJS) $(TARGET) $(TARGET).elf $(TARGET).mot
console :
- minicom -o console -b 9600 -D $(H8WRITE_SERDEV)
+ minicom -b 9600 -D $(H8WRITE_SERDEV)
\r
#include "diskio.h"\r
#include "portconf.h"\r
+#include "spi.h"\r
\r
/*-------------------------------------------------------------------------*/\r
/* Platform dependent macros and functions needed to be modified */\r
#define DLY_US(n) do { volatile uint32 dlycnt; for (dlycnt = 0; dlycnt < (n) * 10; dlycnt++) {} } while (0) /* Delay n microseconds */\r
#define FORWARD(d) do { } while (0) /* Data in-time processing function (depends on the project) */\r
\r
-#define CS_H() do { *PORTCONF_P4DR |= PORTCONF_P4BIT_SDCCS; } while (0) /* Set MMC CS "high" */\r
-#define CS_L() do { *PORTCONF_P4DR &= ~PORTCONF_P4BIT_SDCCS; } while (0) /* Set MMC CS "low" */\r
-#define CK_H() do { *PORTCONF_PBDR |= PORTCONF_PBBIT_SCLK; } while (0) /* Set MMC SCLK "high" */\r
-#define CK_L() do { *PORTCONF_PBDR &= ~PORTCONF_PBBIT_SCLK; } while (0) /* Set MMC SCLK "low" */\r
-#define DI_H() do { *PORTCONF_PBDR |= PORTCONF_PBBIT_MOSI; } while (0) /* Set MMC DI "high" */\r
-#define DI_L() do { *PORTCONF_PBDR &= ~PORTCONF_PBBIT_MOSI; } while (0) /* Set MMC DI "low" */\r
-#define DO ((*PORTCONF_PBDR & PORTCONF_PBBIT_MISO) ? 1 : 0) /* Get MMC DO value (high:true, low:false) */\r
-\r
/*--------------------------------------------------------------------------\r
Module Private Functions\r
---------------------------------------------------------------------------*/\r
/* Definitions for MMC/SDC command */\r
#define CMD0 (0x40+0) /* GO_IDLE_STATE */\r
#define CMD1 (0x40+1) /* SEND_OP_COND (MMC) */\r
-#define ACMD41 (0xC0+41) /* SEND_OP_COND (SDC) */\r
+#define ACMD41 (0xC0+41) /* SEND_OP_COND (SDC) */\r
#define CMD8 (0x40+8) /* SEND_IF_COND */\r
#define CMD16 (0x40+16) /* SET_BLOCKLEN */\r
#define CMD17 (0x40+17) /* READ_SINGLE_BLOCK */\r
#define CT_SDC (CT_SD1|CT_SD2) /* SD */\r
#define CT_BLOCK 0x08 /* Block addressing */\r
\r
-\r
-\r
-static\r
-BYTE CardType; /* b0:MMC, b1:SDv1, b2:SDv2, b3:Block addressing */\r
-\r
-\r
-\r
-/*-----------------------------------------------------------------------*/\r
-/* Transmit a byte to the MMC (bitbanging) */\r
-/*-----------------------------------------------------------------------*/\r
-\r
-static\r
-void xmit_mmc (\r
- BYTE d /* Data to be sent */\r
-)\r
-{\r
- if (d & 0x80) DI_H(); else DI_L(); /* bit7 */\r
- CK_H(); CK_L();\r
- if (d & 0x40) DI_H(); else DI_L(); /* bit6 */\r
- CK_H(); CK_L();\r
- if (d & 0x20) DI_H(); else DI_L(); /* bit5 */\r
- CK_H(); CK_L();\r
- if (d & 0x10) DI_H(); else DI_L(); /* bit4 */\r
- CK_H(); CK_L();\r
- if (d & 0x08) DI_H(); else DI_L(); /* bit3 */\r
- CK_H(); CK_L();\r
- if (d & 0x04) DI_H(); else DI_L(); /* bit2 */\r
- CK_H(); CK_L();\r
- if (d & 0x02) DI_H(); else DI_L(); /* bit1 */\r
- CK_H(); CK_L();\r
- if (d & 0x01) DI_H(); else DI_L(); /* bit0 */\r
- CK_H(); CK_L();\r
-}\r
-\r
-\r
-\r
-/*-----------------------------------------------------------------------*/\r
-/* Receive a byte from the MMC (bitbanging) */\r
-/*-----------------------------------------------------------------------*/\r
-\r
-static\r
-BYTE rcvr_mmc (void)\r
-{\r
- BYTE r;\r
-\r
-\r
- DI_H(); /* Send 0xFF */\r
-\r
- r = 0; if (DO) r++; /* bit7 */\r
- CK_H(); CK_L();\r
- r <<= 1; if (DO) r++; /* bit6 */\r
- CK_H(); CK_L();\r
- r <<= 1; if (DO) r++; /* bit5 */\r
- CK_H(); CK_L();\r
- r <<= 1; if (DO) r++; /* bit4 */\r
- CK_H(); CK_L();\r
- r <<= 1; if (DO) r++; /* bit3 */\r
- CK_H(); CK_L();\r
- r <<= 1; if (DO) r++; /* bit2 */\r
- CK_H(); CK_L();\r
- r <<= 1; if (DO) r++; /* bit1 */\r
- CK_H(); CK_L();\r
- r <<= 1; if (DO) r++; /* bit0 */\r
- CK_H(); CK_L();\r
-\r
- return r;\r
-}\r
-\r
-\r
+static BYTE CardType; /* b0:MMC, b1:SDv1, b2:SDv2, b3:Block addressing */\r
\r
/*-----------------------------------------------------------------------*/\r
/* Skip bytes on the MMC (bitbanging) */\r
/*-----------------------------------------------------------------------*/\r
\r
-static\r
-void skip_mmc (\r
- WORD n /* Number of bytes to skip */\r
-)\r
+/* Number of bytes to skip */\r
+static void skip_mmc(WORD n)\r
{\r
- DI_H(); /* Send 0xFF */\r
-\r
- do {\r
- CK_H(); CK_L();\r
- CK_H(); CK_L();\r
- CK_H(); CK_L();\r
- CK_H(); CK_L();\r
- CK_H(); CK_L();\r
- CK_H(); CK_L();\r
- CK_H(); CK_L();\r
- CK_H(); CK_L();\r
- } while (--n);\r
+ do {\r
+ spi_rx();\r
+ } while (--n);\r
}\r
\r
-\r
-\r
/*-----------------------------------------------------------------------*/\r
/* Deselect the card and release SPI bus */\r
/*-----------------------------------------------------------------------*/\r
\r
-static\r
-void release_spi (void)\r
+static void release_spi(void)\r
{\r
- CS_H();\r
- rcvr_mmc();\r
+ spi_deselect();\r
+ spi_rx();\r
}\r
\r
\r
}\r
\r
/* Select the card */\r
- CS_H(); rcvr_mmc();\r
- CS_L(); rcvr_mmc();\r
+ spi_deselect(); spi_rx();\r
+ spi_select(SpiTarget_SDCARD); spi_rx();\r
\r
/* Send a command packet */\r
- xmit_mmc(cmd); /* Start + Command index */\r
- xmit_mmc((BYTE)(arg >> 24)); /* Argument[31..24] */\r
- xmit_mmc((BYTE)(arg >> 16)); /* Argument[23..16] */\r
- xmit_mmc((BYTE)(arg >> 8)); /* Argument[15..8] */\r
- xmit_mmc((BYTE)arg); /* Argument[7..0] */\r
+ spi_tx(cmd); /* Start + Command index */\r
+ spi_tx((BYTE)(arg >> 24)); /* Argument[31..24] */\r
+ spi_tx((BYTE)(arg >> 16)); /* Argument[23..16] */\r
+ spi_tx((BYTE)(arg >> 8)); /* Argument[15..8] */\r
+ spi_tx((BYTE)arg); /* Argument[7..0] */\r
n = 0x01; /* Dummy CRC + Stop */\r
if (cmd == CMD0) n = 0x95; /* Valid CRC for CMD0(0) */\r
if (cmd == CMD8) n = 0x87; /* Valid CRC for CMD8(0x1AA) */\r
- xmit_mmc(n);\r
+ spi_tx(n);\r
\r
/* Receive a command response */\r
n = 10; /* Wait for a valid response in timeout of 10 attempts */\r
do {\r
- res = rcvr_mmc();\r
+ res = spi_rx();\r
} while ((res & 0x80) && --n);\r
\r
return res; /* Return with the response value */\r
BYTE n, cmd, ty, buf[4];\r
UINT tmr;\r
\r
-\r
INIT_PORT();\r
\r
- CS_H();\r
+ spi_deselect();\r
skip_mmc(10); /* Dummy clocks */\r
\r
ty = 0;\r
if (send_cmd(CMD0, 0) == 1) { /* Enter Idle state */\r
if (send_cmd(CMD8, 0x1AA) == 1) { /* SDv2 */\r
- for (n = 0; n < 4; n++) buf[n] = rcvr_mmc(); /* Get trailing return value of R7 resp */\r
+ for (n = 0; n < 4; n++) buf[n] = spi_rx(); /* Get trailing return value of R7 resp */\r
if (buf[2] == 0x01 && buf[3] == 0xAA) { /* The card can work at vdd range of 2.7-3.6V */\r
for (tmr = 1000; tmr; tmr--) { /* Wait for leaving idle state (ACMD41 with HCS bit) */\r
if (send_cmd(ACMD41, 1UL << 30) == 0) break;\r
DLY_US(1000);\r
}\r
if (tmr && send_cmd(CMD58, 0) == 0) { /* Check CCS bit in the OCR */\r
- for (n = 0; n < 4; n++) buf[n] = rcvr_mmc();\r
+ for (n = 0; n < 4; n++) buf[n] = spi_rx();\r
ty = (buf[0] & 0x40) ? CT_SD2 | CT_BLOCK : CT_SD2; /* SDv2 (HC or SC) */\r
}\r
}\r
tmr = 1000;\r
do { /* Wait for data packet in timeout of 100ms */\r
DLY_US(100);\r
- d = rcvr_mmc();\r
+ d = spi_rx();\r
} while (d == 0xFF && --tmr);\r
\r
if (d == 0xFE) { /* A data packet arrived */\r
/* Receive a part of the sector */\r
if (buff) { /* Store data to the memory */\r
do\r
- *buff++ = rcvr_mmc();\r
+ *buff++ = spi_rx();\r
while (--cnt);\r
} else { /* Forward data to the outgoing stream */\r
do {\r
- d = rcvr_mmc();\r
+ d = spi_rx();\r
FORWARD(d);\r
} while (--cnt);\r
}\r
if (buff) { /* Send data bytes */\r
bc = (WORD)sa;\r
while (bc && wc) { /* Send data bytes to the card */\r
- xmit_mmc(*buff++);\r
+ spi_tx(*buff++);\r
wc--; bc--;\r
}\r
res = RES_OK;\r
if (sa) { /* Initiate sector write process */\r
if (!(CardType & CT_BLOCK)) sa *= 512; /* Convert to byte address if needed */\r
if (send_cmd(CMD24, sa) == 0) { /* WRITE_SINGLE_BLOCK */\r
- xmit_mmc(0xFF); xmit_mmc(0xFE); /* Data block header */\r
+ spi_tx(0xFF); spi_tx(0xFE); /* Data block header */\r
wc = 512; /* Set byte counter */\r
res = RES_OK;\r
}\r
} else { /* Finalize sector write process */\r
bc = wc + 2;\r
- while (bc--) xmit_mmc(0); /* Fill left bytes and CRC with zeros */\r
- if ((rcvr_mmc() & 0x1F) == 0x05) { /* Receive data resp and wait for end of write process in timeout of 300ms */\r
- for (tmr = 10000; rcvr_mmc() != 0xFF && tmr; tmr--) /* Wait for ready (max 1000ms) */\r
+ while (bc--) spi_tx(0); /* Fill left bytes and CRC with zeros */\r
+ if ((spi_rx() & 0x1F) == 0x05) { /* Receive data resp and wait for end of write process in timeout of 300ms */\r
+ for (tmr = 10000; spi_rx() != 0xFF && tmr; tmr--) /* Wait for ready (max 1000ms) */\r
DLY_US(100);\r
if (tmr) res = RES_OK;\r
}\r
#define DI_L() do { *PORTCONF_PBDR &= ~PORTCONF_PBBIT_MOSI; } while (0) /* Set MMC DI "low" */
#define DO ((*PORTCONF_PBDR & PORTCONF_PBBIT_MISO) ? 1 : 0) /* Get MMC DO value (high:true, low:false) */
+#define VS1011E_CTRL_H() do { *PORTCONF_P4DR |= PORTCONF_P4BIT_VSCCS; } while (0)
+#define VS1011E_CTRL_L() do { *PORTCONF_P4DR &= ~PORTCONF_P4BIT_VSCCS; } while (0)
+#define VS1011E_DATA_H() do { *PORTCONF_P4DR |= PORTCONF_P4BIT_VSDCS; } while (0)
+#define VS1011E_DATA_L() do { *PORTCONF_P4DR &= ~PORTCONF_P4BIT_VSDCS; } while (0)
+#define SDCARD_H() do { *PORTCONF_P4DR |= PORTCONF_P4BIT_SDCCS; } while (0) /* Set MMC CS "high" */
+#define SDCARD_L() do { *PORTCONF_P4DR &= ~PORTCONF_P4BIT_SDCCS; } while (0) /* Set MMC CS "low" */
+
void spi_init(void)
{
}
return r;
}
+void spi_select(SpiTarget st)
+{
+ spi_deselect();
+ switch (st) {
+ case SpiTarget_VS1011E_CTRL:
+ VS1011E_CTRL_L();
+ break;
+ case SpiTarget_VS1011E_DATA:
+ VS1011E_DATA_L();
+ break;
+ case SpiTarget_SDCARD:
+ SDCARD_L();
+ break;
+ }
+}
+
+void spi_deselect(void)
+{
+ VS1011E_CTRL_H();
+ VS1011E_DATA_H();
+ SDCARD_H();
+}
+
#include "defines.h"
+typedef enum {
+ SpiTarget_VS1011E_CTRL,
+ SpiTarget_VS1011E_DATA,
+ SpiTarget_SDCARD
+} SpiTarget;
+
void spi_init(void);
void spi_tx(uint8 d);
uint8 spi_rx(void);
+void spi_select(SpiTarget st);
+void spi_deselect(void);
#endif
#define SCI_BASS_BITBASS_SB_AMP 4
#define SCI_BASS_BITBASS_SB_FREQ 0
-#define VS1011E_VSCTL1() do { *PORTCONF_P4DR |= PORTCONF_P4BIT_VSCCS; } while (0)
-#define VS1011E_VSCTL0() do { *PORTCONF_P4DR &= ~PORTCONF_P4BIT_VSCCS; } while (0)
-
-#define VS1011E_VSDAT1() do { *PORTCONF_P4DR |= PORTCONF_P4BIT_VSDCS; } while (0)
-#define VS1011E_VSDAT0() do { *PORTCONF_P4DR &= ~PORTCONF_P4BIT_VSDCS; } while (0)
-
#define VS1011E_RESET1() do { *PORTCONF_P4DR |= PORTCONF_P4BIT_VSRST; } while (0)
#define VS1011E_RESET0() do { *PORTCONF_P4DR &= ~PORTCONF_P4BIT_VSRST; } while (0)
VS1011E_RESET0();
// Delay 30ms
_delay_ms(30);
- // Deassert CS by setting to high level
- VS1011E_VSCTL1();
- // Deassert DCS
- VS1011E_VSDAT1();
+ // Deassert CS
+ spi_deselect();
// Release vs1011 reset
VS1011E_RESET1();
// Delay 10ms (2.5ms accordig to datasheet)
// Rewrite SCI_CLOCKF after soft reset
vs1011e_write(REGADDR_CLOCKF, 0x9800);
// Assert DCS
- VS1011E_VSDAT0();
+ spi_select(SpiTarget_VS1011E_DATA);
// Check the DREQ.
while (VS1011E_CHK_DREQ()) {
}
spi_tx(0x00);
}
// Deassert DCS
- VS1011E_VSDAT1();
+ spi_deselect();
}
void vs1011e_cancel_data()
while (VS1011E_CHK_DREQ()) {
}
- VS1011E_VSDAT0();
+ spi_select(SpiTarget_VS1011E_DATA);
for (i = 0; i < 2048; i++) {
while (VS1011E_CHK_DREQ()) {
}
spi_tx(0x00);
}
- VS1011E_VSDAT1();
+ spi_deselect();
}
void vs1011e_set_enhancer(uint8 st_amp, uint8 st_freq, uint8 sb_amp,
*/
for (i = 0; i < UNITBYTE; i++) {
while (VS1011E_CHK_DREQ()) { }
- VS1011E_VSDAT0();
+ spi_select(SpiTarget_VS1011E_DATA);
spi_tx(*(buf + i));
- VS1011E_VSDAT1();
+ spi_deselect();
}
}
}
while (VS1011E_CHK_DREQ()) {
}
- VS1011E_VSDAT0();
+ spi_select(SpiTarget_VS1011E_DATA);
spi_tx(0x53);
spi_tx(0xEF);
spi_tx(0x6E);
spi_tx(0x00);
spi_tx(0x00);
spi_tx(0x00);
- VS1011E_VSDAT1();
+ spi_deselect();
}
void vs1011e_sinetest_fini()
while (VS1011E_CHK_DREQ()) {
}
- VS1011E_VSDAT0();
+ spi_select(SpiTarget_VS1011E_DATA);
spi_tx(0x45);
spi_tx(0x78);
spi_tx(0x69);
spi_tx(0x00);
spi_tx(0x00);
spi_tx(0x00);
- VS1011E_VSDAT1();
+ spi_deselect();
vs1011e_cancel_data();
}
while (VS1011E_CHK_DREQ()) {
}
- VS1011E_VSCTL0();
+ spi_select(SpiTarget_VS1011E_CTRL);
spi_tx(VS1011E_OPCODE_READ);
spi_tx(addr);
*stat |= spi_rx() << 8;
*stat |= spi_rx();
- VS1011E_VSCTL1();
+ spi_deselect();
}
static void vs1011e_write(uint8 addr, uint16 stat)
while (VS1011E_CHK_DREQ()) {
}
- VS1011E_VSCTL0();
+ spi_select(SpiTarget_VS1011E_CTRL);
spi_tx(VS1011E_OPCODE_WRITE);
spi_tx(addr);
spi_tx(stat >> 8);
spi_tx(stat >> 0);
- VS1011E_VSCTL1();
+ spi_deselect();
}
--- /dev/null
+# Doxyfile 1.7.1
+
+# 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 = "H8/3069F write for KOZOS"
+
+# 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.0
+
+# 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 = doc
+
+# 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 = Japanese
+
+# 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 = YES
+
+# 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 =
+
+# 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 = NO
+
+# 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, CSharp, 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 = NO
+
+# 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 FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# 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_MEMBERS_CTORS_1ST tag is set to YES then doxygen
+# will sort the (brief and detailed) documentation of class members so that
+# constructors and destructors are listed first. If set to NO (the default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = 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 = 24
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# 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 <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> 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 = YES
+
+# 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 = .
+
+# 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 <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> 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 = YES
+
+# 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 = YES
+
+# 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 =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
+# Doxygen will adjust the colors in the stylesheet and background images
+# according to this color. Hue is specified as an angle on a colorwheel,
+# see http://en.wikipedia.org/wiki/Hue for more information.
+# For instance the value 0 represents red, 60 is yellow, 120 is green,
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
+# The allowed range is 0 to 359.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
+# the colors in the HTML output. For a value of 0 the output will use
+# grayscales only. A value of 255 will produce the most vivid colors.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
+# the luminance component of the colors in the HTML output. Values below
+# 100 gradually make the output lighter, whereas values above 100 make
+# the output darker. The value divided by 100 is the actual gamma applied,
+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
+# and 100 does not change the gamma.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP = YES
+
+# 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
+
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# 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 = org.doxygen.Project
+
+# 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
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+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 =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+# will be generated, which together with the HTML files, form an Eclipse help
+# plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
+# the help appears.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# 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 YES, 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 (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW = YES
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES = NO
+
+# 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
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
+# links to external symbols imported via tag files in a separate window.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# 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
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are
+# not supported properly for IE 6.0, but are supported on all modern browsers.
+# Note that when changing this option you need to delete any form_*.png files
+# in the HTML output before the changes have effect.
+
+FORMULA_TRANSPARENT = YES
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
+# for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using
+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
+# (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a PHP enabled web server instead of at the web client
+# using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server
+# based approach is that it scales better to large projects and allows
+# full text search. The disadvances is that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH = NO
+
+#---------------------------------------------------------------------------
+# 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.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+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 = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS = 0
+
+# 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.ttf
+
+# 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 = YES
+
+# 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 = YES
+
+# 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 = YES
+
+# 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
--- /dev/null
+TARGET1=kz_h8write
+SRCS1=kz_h8write.c serial_linux.c mot.c optparse.c
+
+TARGET2=motdump
+SRCS2=motdump.c mot.c
+
+all: $(TARGET1) $(TARGET2)
+
+clean:
+ @rm -f $(TARGET1) $(TARGET2)
+
+$(TARGET1):$(SRCS1)
+ $(CC) -o $(TARGET1) $(SRCS1) -std=c99 -g -Wall
+
+$(TARGET2):$(SRCS2)
+ $(CC) -o $(TARGET2) $(SRCS2) -std=c99 -g -Wall
--- /dev/null
+
+=============================================
+ KOZOS H8/3069F Flash Writer.
+ Copyright(C) 2011-2012 Shinichiro Nakamura
+=============================================
+
+KOZOS H8/3069F Flash WriterはKOZOS本を楽しむために
+H8/3069Fを手にしたけど、有名なh8writeでは書き込みに
+失敗するという方のために作られたフラッシュライタです。
+
+Makefile メイクファイル
+README.txt このファイル
+kz_h8write.c 本体用ソースコード
+kz_h8write.h 本体用ヘッダファイル
+mot.c motファイル読み込みモジュールの実装
+mot.h motファイル読み込みモジュールのインターフェース
+motdump.c motファイルダンププログラムの実装
+serial_linux.c シリアルポートライブラリの実装(Linux)
+serial_windows.c シリアルポートライブラリの実装(Windows)
+serial.h シリアルポートライブラリのインターフェース
+
+=======================================
+ 使い方
+=======================================
+ motファイル名、ボードクロック[MHz]、シリアルポート名を与えて実行します。
+
+ 例) kz_h8write -3069 -f20 kzload.mot /dev/ttyUSB0 (Linux)
+ 例) kz_h8write -3069 -f20 kzload.mot COM5 (Windows)
+
+ 書き込みに成功した場合、実行表示の最後にComplete.と表示されます。
+
+=======================================
+ バージョン
+=======================================
+2011/05/26 Version 0.0.1
+ 初版
+
+2011/05/28 Version 0.0.2
+ メモリ消去コマンドに対する応答処理の不具合を修正。
+ 異常終了時にシェルに返すコードが正常時と区別できない不具合を修正。
+ 24ビットアドレスモード、32ビットアドレスモードの処理不具合を修正。
+ シリアルポートをクローズして終了するように修正。
+ メモリ消去時、書き込み時に進捗を示す表示を追加。
+
+2011/05/31 Version 0.0.3
+ Windowsに対応。
+ バージョン番号を表示を追加。
+ シリアルボーレート合わせ込みシーケンスに再試行処理を追加。
+ 付属プログラムmotdumpの表示処理のマイナーバグを修正。
+
+2012/04/30 Version 0.1.0
+ 引数の指定方法を書籍で使っている範囲でh8writeと互換性をとるようにした。
+ 書籍では、-3069、-f20、MOTファイル名、シリアルデバイスが指定されている。
+
+=======================================
+ 謝辞
+=======================================
+やまちゅうさん
+ Version 0.0.1でおきる問題について詳細なレポートを頂きました。
+
--- /dev/null
+/**
+ * @file kz_h8write.c
+ * @author Shinichiro Nakamura
+ * @brief H8/3069F write for KOZOSの実装。
+ */
+
+/*
+ * ===============================================================
+ * KOZOS h8write
+ * Version 0.1.0
+ * ===============================================================
+ * Copyright (c) 2010-2011 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include <stdint.h>
+#include "serial.h"
+#include "mot.h"
+#include "optparse.h"
+#include "kz_h8write.h"
+
+/**
+ * @brief プログラム終了用マクロ。
+ * @details このマクロはシリアルポートのオープン成功後の処理に用いる。
+ * @param CODE シェルに返すコード番号。
+ */
+#define PROGEXIT(CODE) serial_close(serial); exit(CODE)
+
+/**
+ * @brief シリアルタイムアウト時間。
+ * @details この定義はシリアルポートからの読み出しで使用される。
+ */
+#define SERIAL_TIMEOUT_MS 500
+
+/**
+ * @brief ユーザオプション構造体。
+ */
+typedef struct {
+ char cpu_name[BUFSIZ]; /**< CPU名。 */
+ int cpu_freq; /**< CPU周波数。 */
+ char mot_file[BUFSIZ]; /**< MOTファイル名。NULLなら標準入力。 */
+ char serial_port[BUFSIZ]; /**< シリアルポート名。 */
+ int version; /**< バージョンフラグ。 */
+ int help; /**< ヘルプフラグ。 */
+ int debug; /**< デバッグフラグ。 */
+ int error; /**< オプション指定エラー検出フラグ。 */
+} user_option_t;
+
+#define USER_OPTION_CPU_NAME(P) ((P)->cpu_name)
+#define USER_OPTION_CPU_FREQ(P) ((P)->cpu_freq)
+#define USER_OPTION_MOT_FILE(P) ((P)->mot_file)
+#define USER_OPTION_SERIAL_PORT(P) ((P)->serial_port)
+#define USER_OPTION_VERSION(P) ((P)->version)
+#define USER_OPTION_HELP(P) ((P)->help)
+#define USER_OPTION_DEBUG(P) ((P)->debug)
+#define USER_OPTION_ERROR(P) ((P)->error)
+
+static unsigned char memory_image[0x100000 + 0x100];
+static unsigned int memory_lastaddr = 0;
+
+int com_getc(SERIAL *serial);
+int com_putc(SERIAL *serial, unsigned char c);
+int write_request(
+ SERIAL *serial,
+ const unsigned char cmd,
+ const unsigned char *buf,
+ const unsigned char siz);
+int read_response(
+ SERIAL *serial,
+ unsigned char *buf,
+ size_t siz);
+enum ErrorCode bitrate_sequence(SERIAL *serial);
+enum ErrorCode inquiry_device(SERIAL *serial, uint32_t *devcode);
+enum ErrorCode select_device(SERIAL *serial, const uint32_t devcode);
+enum ErrorCode inquiry_clockmode(SERIAL *serial);
+enum ErrorCode select_clockmode(SERIAL *serial);
+enum ErrorCode select_bitrate(SERIAL *serial, const int baudrate, const int clock_mhz);
+enum ErrorCode program(SERIAL *serial);
+
+/**
+ * @brief motモジュールのコールバック関数。
+ * @details motモジュールはファイルを読み込みながらこの関数を呼ぶ。
+ * @param addr データ先頭アドレス。
+ * @param buf バッファへのポインタ。
+ * @param siz バッファに格納されたデータバイトサイズ。
+ */
+void mot_callback(
+ const unsigned int addr,
+ const unsigned char *buf,
+ const int siz)
+{
+ for (int i = 0; i < siz; i++) {
+ memory_image[addr + i] = buf[i];
+ }
+ if (memory_lastaddr < addr) {
+ memory_lastaddr = addr;
+ }
+}
+
+/**
+ * @brief シリアルポートから１文字読み出す。
+ * @details このインターフェースは最大SERIAL_TIMEOUT_MS[ms]の着信を待つ。
+ *
+ * @param serial シリアルハンドラ。
+ *
+ * @return 文字。
+ */
+int com_getc(SERIAL *serial)
+{
+ unsigned char c;
+ if (serial_read_with_timeout(serial, &c, 1, SERIAL_TIMEOUT_MS) != 0) {
+ return EOF;
+ }
+ return c;
+}
+
+/**
+ * @brief シリアルポートへ１文字書き出す。
+ *
+ * @param serial シリアルハンドラ。
+ * @param c 文字。
+ *
+ * @return 書き出した文字。
+ */
+int com_putc(SERIAL *serial, unsigned char c)
+{
+ if (serial_write(serial, &c, 1) != 0) {
+ return EOF;
+ }
+ return (int)c;
+}
+
+/**
+ * @brief リクエストを書き込む。
+ *
+ * @param serial シリアルハンドラ。
+ * @param cmd コマンド。
+ * @param buf バッファへのポインタ。
+ * @param siz バッファに格納されたデータバイト数。
+ *
+ * @retval 0 成功。
+ * @retval 0以外 失敗。エラー番号。
+ */
+int write_request(
+ SERIAL *serial,
+ const unsigned char cmd,
+ const unsigned char *buf,
+ const unsigned char siz)
+{
+ /*
+ * コマンドとサイズを書き込む。
+ */
+ if (serial_write(serial, &cmd, 1) != 0) {
+ return -1;
+ }
+ if (serial_write(serial, &siz, 1) != 0) {
+ return -2;
+ }
+ /*
+ * データを書き込む。
+ */
+ if (serial_write(serial, buf, siz) != 0) {
+ return -3;
+ }
+ /*
+ * チェックサムを計算して書き込む。
+ */
+ unsigned char chksum = 0;
+ chksum += cmd;
+ chksum += siz;
+ for (int i = 0; i < siz; i++) {
+ chksum += buf[i];
+ }
+ chksum = -chksum;
+ if (serial_write(serial, &chksum, 1) != 0) {
+ return -4;
+ }
+ return 0;
+}
+
+/**
+ * @brief レスポンスを読み込む。
+ * @details
+ * プロセッサからは以下のフォーマットで情報が返る。
+ * 1. コマンド。
+ * 2. サイズ。(コマンド、サイズ、チェックサムを除く。)
+ * 3. データ。
+ * 4. チェックサム。
+ *
+ * @param serial シリアルハンドラ。
+ * @param buf バッファ。
+ * @param siz バッファサイズ。
+ *
+ * @retval 1以上 読み込んだ文字数。
+ * @retval 0以下 エラー。
+ */
+int read_response(SERIAL *serial, unsigned char *buf, size_t siz)
+{
+ /*
+ * コマンド。
+ */
+ if (serial_read_with_timeout(serial, &buf[0], 1, SERIAL_TIMEOUT_MS) != 0) {
+ return -1;
+ }
+
+ /*
+ * データサイズ。
+ */
+ if (serial_read_with_timeout(serial, &buf[1], 1, SERIAL_TIMEOUT_MS) != 0) {
+ return -2;
+ }
+ const int datcnt = buf[1];
+
+ /*
+ * データ。
+ */
+ if (serial_read_with_timeout(serial, &buf[2], datcnt, SERIAL_TIMEOUT_MS) != 0) {
+ return -3;
+ }
+
+ /*
+ * チェックサム。
+ */
+ if (serial_read_with_timeout(serial, &buf[2 + datcnt], 1, SERIAL_TIMEOUT_MS) != 0) {
+ return -4;
+ }
+
+ /*
+ * チェックサム検証。
+ */
+ int chksum = 0;
+ for (int i = 0; i < datcnt + 3; i++) {
+ chksum += buf[i];
+ }
+ if ((chksum & 0xff) != 0x00) {
+ return -5;
+ }
+ return 0;
+}
+
+/**
+ * @brief ビットレート合わせ込みのシーケンスを実行する。
+ *
+ * @details
+ * ビットレートの合わせ込みは以下のシーケンスで行う。
+ * 1. 0x00を最大30回送信する。
+ * 2. 合わせ込みが完了すると0x00が返る。
+ * 3. この時点で0x55を送信する。
+ * 4. レスポンスコードが返る。
+ * 成功：0xE6
+ * 失敗：0xFF
+ *
+ * @param serial シリアルハンドラ。
+ *
+ * @return エラーコード。
+ */
+enum ErrorCode bitrate_sequence(SERIAL *serial)
+{
+ unsigned char sc, rc;
+ int i;
+ for (i = 0; i < 30; i++) {
+ /*
+ * ビットレート計測用マーカを送信する。
+ */
+ sc = 0x00;
+ if (serial_write(serial, &sc, 1) != 0) {
+ return SerialWriteError;
+ }
+ /*
+ * 何かを受信したらコードを確認する。
+ * コードが正しければ応答を行い、そのレスポンスを検証する。
+ */
+ if (serial_read_with_timeout(serial, &rc, 1, SERIAL_TIMEOUT_MS) == 0) {
+ if (rc != 0x00) {
+ /*
+ * 最初の応答は0x00のはず。
+ */
+ return InvalidPrimaryResponseCode;
+ }
+ sc = 0x55;
+ if (serial_write(serial, &sc, 1) != 0) {
+ return SerialWriteError;
+ }
+ if (serial_read_with_timeout(serial, &rc, 1, SERIAL_TIMEOUT_MS) != 0) {
+ /*
+ * 0x55に対する応答があるはず。
+ */
+ return NoSecondaryResponseCode;
+ }
+ if (rc == 0xe6) {
+ return NoError;
+ } else {
+ /*
+ * ２回目の応答は0xe6のはず。
+ */
+ return InvalidSecondaryResponseCode;
+ }
+ }
+ }
+ /*
+ * レスポンスが全くない。
+ */
+ return NoPrimaryResponseCode;
+}
+
+/**
+ * @brief サポートデバイス問い合わせ(0x20)を実行する。
+ *
+ * @param serial シリアルハンドラ。
+ * @param devcode デバイスコード。
+ *
+ * @return エラーコード。
+ */
+enum ErrorCode inquiry_device(SERIAL *serial, uint32_t *devcode)
+{
+ unsigned char buf[BUFSIZ];
+ com_putc(serial, 0x20);
+ if (read_response(serial, &buf[0], sizeof(buf)) != 0) {
+ /*
+ * レスポンスが異常だった場合、
+ * サポートしていないデバイスとして返す。
+ */
+ return UnsupportedDevice;
+ }
+ *devcode =
+ (buf[4] << (8 * 3)) |
+ (buf[5] << (8 * 2)) |
+ (buf[6] << (8 * 1)) |
+ (buf[7] << (8 * 0));
+ return NoError;
+}
+
+/**
+ * @brief デバイス選択(0x10)を実行する。
+ *
+ * @param serial シリアルハンドラ。
+ * @param devcode デバイスコード。
+ *
+ * @return エラーコード。
+ */
+enum ErrorCode select_device(SERIAL *serial, const uint32_t devcode)
+{
+ unsigned char c;
+ unsigned char buf[4];
+ buf[0] = devcode >> (8 * 3);
+ buf[1] = devcode >> (8 * 2);
+ buf[2] = devcode >> (8 * 1);
+ buf[3] = devcode >> (8 * 0);
+ write_request(serial, 0x10, buf, sizeof(buf));
+ c = com_getc(serial);
+ if (c != 0x06) {
+ /*
+ * ACKでない場合、続けてエラーコードが返る。
+ * この時、上位にはデバイスコードの不一致として返す。
+ */
+ c = com_getc(serial);
+ return UnmatchedDeviceCode;
+ }
+ return NoError;
+}
+
+/**
+ * @brief クロックモード問い合わせ(0x21)を実行する。
+ * @param serial シリアルハンドラ。
+ */
+enum ErrorCode inquiry_clockmode(SERIAL *serial) {
+ unsigned char buf[BUFSIZ];
+ com_putc(serial, 0x21);
+ if (read_response(serial, &buf[0], sizeof(buf)) != 0) {
+ return UnsupportedClockMode;
+ }
+ return NoError;
+}
+
+/**
+ * @brief クロックモード選択(0x11)を実行する。
+ *
+ * @param serial シリアルハンドラ。
+ *
+ * @return エラーコード。
+ */
+enum ErrorCode select_clockmode(SERIAL *serial) {
+ unsigned char c;
+ unsigned char buf[1];
+ buf[0] = 0;
+ write_request(serial, 0x11, buf, 1);
+ c = com_getc(serial);
+ if (c != 0x06) {
+ /*
+ * ACKでない場合、続けてエラーコードが返る。
+ * この時、上位にはクロックモードの不一致として返す。
+ */
+ c = com_getc(serial);
+ return UnmatchedClockMode;
+ }
+ return NoError;
+}
+
+/**
+ * @brief 新ビットレート選択(0x3F)を実行する。
+ *
+ * @param serial シリアルハンドラ。
+ * @param baudrate ボーレート。
+ * @param clock_mhz クロック。単位はMHz。
+ */
+enum ErrorCode select_bitrate(
+ SERIAL *serial,
+ const int baudrate,
+ const int clock_mhz)
+{
+ const int baudval = baudrate / 100;
+ const int clkval = clock_mhz * 100;
+ unsigned char buf[7];
+ unsigned char c;
+ buf[0] = baudval / 0x100;
+ buf[1] = baudval % 0x100;
+ buf[2] = clkval / 0x100;
+ buf[3] = clkval % 0x100;
+ buf[4] = 1;
+ buf[5] = 1;
+ buf[6] = 1;
+ write_request(serial, 0x3f, buf, sizeof(buf));
+ c = com_getc(serial);
+ if (c != 0x06) {
+ /*
+ * ACKでない場合、続けてエラーコードが返る。
+ * この時、上位には不正なビットレートとして返す。
+ */
+ c = com_getc(serial);
+ return InvalidBitrate;
+ }
+ /*
+ * 新ビットレートによる双方向ACK確認。
+ */
+ com_putc(serial, 0x06);
+ c = com_getc(serial);
+ if (c != 0x06) {
+ return InvalidBitrate;
+ }
+ return NoError;
+}
+
+/**
+ * @brief 書き込み消去ステータス遷移(0x40)を実行する。
+ *
+ * @param serial シリアルハンドラ。
+ *
+ * @return エラーコード。
+ */
+enum ErrorCode program(SERIAL *serial)
+{
+ unsigned char c;
+
+ /*
+ * 書き込み消去ステータス遷移を実行。
+ */
+
+ /*
+ * H8/3069の場合、メモリ消去にかかる最大時間は
+ * 40000[ms]とデータシートに記されている。
+ * com_getcはSERIAL_TIMEOUT_MS時間のタイムアウトが
+ * 設定されている。
+ * ここでは最大で(40000 / SERIAL_TIMEOUT_MS)回の読み出し
+ * を試行して、期待する応答が帰ってくれば消去に成功
+ * したものとみなす。
+ *
+ * 従来の多くの書き込みソフトウェアはこの処理の多くが
+ * 固定値だった。
+ * もしかしたら、「このH8はもう書けなくなった。」と思う物でも、
+ * 消去に成功してしまうかもしれない。
+ */
+ fprintf(stderr, "Waiting for erase done:");
+ com_putc(serial, 0x40);
+ const int POLL_N_ERASE = (40000 / SERIAL_TIMEOUT_MS);
+ for (int i = 0; i < POLL_N_ERASE; i++) {
+ c = com_getc(serial);
+ if (c == 0x06) {
+ break;
+ }
+ fprintf(stderr, ".");
+ }
+ fprintf(stderr, "\n");
+ if (c != 0x06) {
+ /*
+ * ACKでない場合、続けてエラーコードが返る。
+ * この時、上位には書き込み消去失敗として返す。
+ */
+ c = com_getc(serial);
+ return WriteEraseFail;
+ }
+
+ /*
+ * ユーザマット書き込み選択を実行。
+ */
+ com_putc(serial, 0x43);
+ c = com_getc(serial);
+ if (c != 0x06) {
+ /*
+ * ACKでない場合、続けてエラーコードが返る。
+ */
+ c = com_getc(serial);
+ return WriteEraseFail;
+ }
+
+ /*
+ * 128バイト書き込みを実行する。
+ */
+ fprintf(stderr, "Programming:");
+ for (int i = 0; i < (int)memory_lastaddr; i += 128) {
+ unsigned char buf[256];
+ unsigned char chksum = 0;
+ buf[0] = 0x50;
+ buf[1] = i >> 24;
+ buf[2] = i >> 16;
+ buf[3] = i >> 8;
+ buf[4] = i >> 0;
+ for (int j = 0; j < 128; j++) {
+ buf[5 + j] = memory_image[i + j];
+ }
+ for (int j = 0; j < 128 + 5; j++) {
+ chksum += buf[j];
+ }
+ buf[128 + 5] = -chksum;
+ if (serial_write(serial, buf, 128 + 6) != 0) {
+ return WriteEraseFail;
+ }
+ /*
+ * H8/3069の場合、書き込みにかかる最大時間は
+ * 3000[ms]とデータシートに記されている。
+ * com_getcはSERIAL_TIMEOUT_MS時間のタイムアウトが
+ * 設定されている。
+ * ここでは最大で(3000 / SERIAL_TIMEOUT_MS)回の読み出し
+ * を試行して、期待する応答が帰ってくれば書き込みに成功
+ * したものとみなす。
+ *
+ * 従来の多くの書き込みソフトウェアはこの処理の多くが
+ * 固定値だった。
+ * もしかしたら、「このH8はもう書けなくなった。」と思う物でも、
+ * 書き込みにも成功してしまうかもしれない。
+ */
+ const int POLL_N_WRITE = (3000 / SERIAL_TIMEOUT_MS);
+ for (int i = 0; i < POLL_N_WRITE; i++) {
+ c = com_getc(serial);
+ if (c == 0x06) {
+ break;
+ }
+ fprintf(stderr, ":");
+ }
+ if (c != 0x06) {
+ /*
+ * ACKでない場合、続けてエラーコードが返る。
+ */
+ c = com_getc(serial);
+ return WriteEraseFail;
+ }
+ fprintf(stderr, ".");
+ }
+ fprintf(stderr, "\n");
+
+ /*
+ * 書き込み終了コマンドを送信する。
+ */
+ {
+ unsigned char buf[32];
+ unsigned char chksum = 0;
+ buf[0] = 0x50;
+ buf[1] = 0xff;
+ buf[2] = 0xff;
+ buf[3] = 0xff;
+ buf[4] = 0xff;
+ for (int i = 0; i < 5; i++) {
+ chksum += buf[i];
+ }
+ buf[5] = -chksum;
+ if (serial_write(serial, buf, 6) != 0) {
+ return WriteEraseFail;
+ }
+ c = com_getc(serial);
+ if (c != 0x06) {
+ /*
+ * ACKでない場合、続けてエラーコードが返る。
+ */
+ c = com_getc(serial);
+ return WriteEraseFail;
+ }
+ }
+
+ return NoError;
+}
+
+int optparse_callback(const char option, const char *argument, void *extobj)
+{
+ user_option_t *user_option = (user_option_t *)extobj;
+
+ /*
+ * USER_OPTION_MOT_FILE()とUSER_OPTION_SERIAL_PORT()は別に取得する。
+ */
+ switch (option) {
+ case '3':
+ strcpy(USER_OPTION_CPU_NAME(user_option), "3");
+ strcat(USER_OPTION_CPU_NAME(user_option), argument);
+ break;
+ case 'F':
+ case 'f':
+ if (sscanf(argument, "%i", &USER_OPTION_CPU_FREQ(user_option)) != 1) {
+ USER_OPTION_ERROR(user_option) = 1;
+ }
+ break;
+ case 'V':
+ case 'v':
+ USER_OPTION_VERSION(user_option) = 1;
+ break;
+ case 'H':
+ case 'h':
+ USER_OPTION_HELP(user_option) = 1;
+ break;
+ case 'D':
+ case 'd':
+ USER_OPTION_DEBUG(user_option) = 1;
+ break;
+ }
+
+ return 0;
+}
+
+/**
+ * @brief エントリーポイント。
+ * @param argc 引数の数。
+ * @param argv 引数の中身。
+ * @return シェルに返す値。
+ */
+int main(int argc, char **argv)
+{
+ SERIAL *serial = NULL;
+ enum ErrorCode ec = NoError;
+ uint32_t devcode = 0;
+ user_option_t user_option;
+
+ /*
+ * バナーを表示する。
+ */
+ fprintf(stderr, "=================================================\n");
+ fprintf(stderr, " H8/3069F Flash Writer for KOZOS (Version %d.%d.%d)\n",
+ VERSION_MAJOR,
+ VERSION_MINOR,
+ VERSION_RELEASE);
+ fprintf(stderr, " Copyright(C) 2011-2012 Shinichiro Nakamura\n");
+ fprintf(stderr, "=================================================\n");
+
+ /*
+ * オプションのデフォルト値を設定する。
+ */
+ strcpy(USER_OPTION_CPU_NAME(&user_option), "3069");
+ USER_OPTION_CPU_FREQ(&user_option) = 20;
+ strcpy(USER_OPTION_MOT_FILE(&user_option), "");
+ strcpy(USER_OPTION_SERIAL_PORT(&user_option), "");
+ USER_OPTION_VERSION(&user_option) = 0;
+ USER_OPTION_HELP(&user_option) = 0;
+ USER_OPTION_DEBUG(&user_option) = 0;
+ USER_OPTION_ERROR(&user_option) = 0;
+
+ /*
+ * 文字ベースでオプションを解析する。
+ */
+ optparse_char(argc, argv, &user_option, optparse_callback);
+
+ /*
+ * オプションの指定に誤りがある場合には、使い方を表示して終了する。
+ */
+ if ((argc < 3) || USER_OPTION_ERROR(&user_option)
+ || USER_OPTION_VERSION(&user_option) || USER_OPTION_HELP(&user_option)) {
+ fprintf(stderr, "%s [options...] [mot file] [interface]\n", argv[0]);
+ fprintf(stderr, "\n");
+ fprintf(stderr, " Target CPU : -3069 (Default:3069)\n");
+ fprintf(stderr, " Target Frequency : -f[20 | 25] (Default:20)\n");
+ fprintf(stderr, " Version : -v\n");
+ fprintf(stderr, " Help : -h\n");
+ fprintf(stderr, " Debug : -d\n");
+ exit(1);
+ }
+
+ /*
+ * 与えられた引数の最後の二つは、それぞれMOTファイルとシリアルポート名であるという仮定。
+ */
+ strcpy(USER_OPTION_MOT_FILE(&user_option), argv[argc - 2]);
+ strcpy(USER_OPTION_SERIAL_PORT(&user_option), argv[argc - 1]);
+
+ /*
+ * デバッグ用の出力。
+ */
+ if (USER_OPTION_DEBUG(&user_option)) {
+ fprintf(stderr, "Target CPU : %s\n", USER_OPTION_CPU_NAME(&user_option));
+ fprintf(stderr, "Target Frequency : %d\n", USER_OPTION_CPU_FREQ(&user_option));
+ fprintf(stderr, "MOT File : %s\n", USER_OPTION_MOT_FILE(&user_option));
+ fprintf(stderr, "Seiral Port : %s\n", USER_OPTION_SERIAL_PORT(&user_option));
+ }
+
+ /*
+ * 与えられたオプションを検証する。
+ */
+ if (strcmp(USER_OPTION_CPU_NAME(&user_option), "3069") != 0) {
+ /*
+ * 3069F以外はエラーとする。
+ * 3069F以外で検証するつもりは今のところないから対象外とする。
+ * プロトコルが同じなら書き込めるだろう。
+ */
+ fprintf(stderr, "Unsupported CPU name found.\n");
+ exit(1);
+ }
+ if ((USER_OPTION_CPU_FREQ(&user_option) != 20) && (USER_OPTION_CPU_FREQ(&user_option) != 25)) {
+ /*
+ * 20MHzでもなく、25MHzでもなければエラー。
+ */
+ fprintf(stderr, "Unsupported CPU frequency value found.\n");
+ exit(1);
+ }
+
+ /*
+ * motファイルを読み込む。
+ */
+ mot_t mot;
+ mot.cb_data = mot_callback;
+ if (mot_read(USER_OPTION_MOT_FILE(&user_option), &mot) != 0) {
+ fprintf(stderr, "file read error\n");
+ exit(1);
+ }
+
+ /*
+ * シリアルポートをオープンする。
+ */
+ serial = serial_open(USER_OPTION_SERIAL_PORT(&user_option), SerialBaud19200);
+ if (serial == NULL) {
+ fprintf(stderr, "com port open error\n");
+ exit(1);
+ }
+
+ /*
+ * ビットレート合わせ込みのシーケンスを実行する。
+ *
+ * ビットレート合わせ込みシーケンスに初回時失敗する事がある。
+ * マイコンの電源投入時やシリアルケーブル接続時に
+ * プロセッサのUARTポートに意図しない信号が入る事が考えられる。
+ *
+ * そこで、本プログラムでは数回の試行を行うことにした。
+ * これはユーザがかけている手間をプログラムが代行する事を意味する。
+ */
+ for (int i = 0; i < 2; i++) {
+ ec = bitrate_sequence(serial);
+ if (ec == NoError) {
+ break;
+ } else {
+ /*
+ * デバッグ用出力。
+ *
+ * ビットレートシーケンスは初回に失敗する可能性がある。
+ * これに対してエラーを表示してしまうとユーザが混乱する。
+ * よってデバッグ用出力としての位置づけにしておく。
+ * リトライした結果として成功した事を知りたい時にのみ
+ * 表示を有効にすると良い。
+ */
+ if (USER_OPTION_DEBUG(&user_option)) {
+ fprintf(stderr, "Bitrate sequence failed.\n");
+ }
+ }
+ }
+ if (ec != NoError) {
+ fprintf(stderr, "Bitrate sequence failed. (code=0x%02x)\n", (int)ec);
+ PROGEXIT(1);
+ }
+ fprintf(stderr, "Bitrate sequence: Done.\n");
+
+ /*
+ * サポートデバイス問い合わせを実行する。
+ */
+ ec = inquiry_device(serial, &devcode);
+ if (ec != NoError) {
+ fprintf(stderr, "Inquiry device failed. (code=0x%02x)\n", (int)ec);
+ PROGEXIT(1);
+ }
+ fprintf(stderr, "Inquiry device: Done.\n");
+
+ /*
+ * デバイス選択を実行する。
+ */
+ ec = select_device(serial, devcode);
+ if (ec != NoError) {
+ fprintf(stderr, "Select device failed. (code=0x%02x)\n", (int)ec);
+ PROGEXIT(1);
+ }
+ fprintf(stderr, "Select device: Done.\n");
+
+ /*
+ * クロックモード問い合わせを実行する。
+ */
+ ec = inquiry_clockmode(serial);
+ if (ec != NoError) {
+ fprintf(stderr, "Inquiry clock mode failed. (code=0x%02x)\n", (int)ec);
+ PROGEXIT(1);
+ }
+ fprintf(stderr, "Inquiry clock mode: Done.\n");
+
+ /*
+ * クロックモード選択を実行する。
+ */
+ ec = select_clockmode(serial);
+ if (ec != NoError) {
+ fprintf(stderr, "Select clock mode failed. (code=0x%02x)\n", (int)ec);
+ PROGEXIT(1);
+ }
+ fprintf(stderr, "Select clock mode: Done.\n");
+
+ /*
+ * 新ビットレート選択を実行する。
+ */
+ ec = select_bitrate(serial, 19200, USER_OPTION_CPU_FREQ(&user_option));
+ if (ec != NoError) {
+ fprintf(stderr, "Select bitrate failed. (code=0x%02x)\n", (int)ec);
+ PROGEXIT(1);
+ }
+ fprintf(stderr, "Select bitrate: Done.\n");
+
+ /*
+ * 書き込み消去ステータス遷移を実行する。
+ * 同時に128バイト書き込みを実行する。
+ */
+ ec = program(serial);
+ if (ec != NoError) {
+ fprintf(stderr, "Program failed. (code=0x%02x)\n", (int)ec);
+ PROGEXIT(1);
+ }
+ fprintf(stderr, "Program: Done.\n");
+
+ /*
+ * 上記のステップ全てに成功した時にのみCompleteが表示される。
+ */
+ fprintf(stderr, "Complete.\n");
+ PROGEXIT(0);
+}
+
--- /dev/null
+/**
+ * @file kz_h8write.h
+ * @author Shinichiro Nakamura
+ * @brief H8/3069F write for KOZOSのインターフェース定義。
+ */
+
+/*
+ * ===============================================================
+ * KOZOS h8write
+ * Version 0.1.0
+ * ===============================================================
+ * Copyright (c) 2010-2011 Shinichiro Nakamura
+ *
+ * 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 KZ_H8WRITE_H
+#define KZ_H8WRITE_H
+
+#define VERSION_MAJOR 0
+#define VERSION_MINOR 1
+#define VERSION_RELEASE 0
+
+/**
+ * @brief エラーコード。
+ */
+enum ErrorCode {
+ NoError = 0,
+ SerialOpenError,
+ SerialWriteError,
+ InvalidPrimaryResponseCode,
+ NoPrimaryResponseCode,
+ InvalidSecondaryResponseCode,
+ NoSecondaryResponseCode,
+ UnsupportedDevice,
+ UnmatchedDeviceCode,
+ UnsupportedClockMode,
+ UnmatchedClockMode,
+ InvalidBitrate,
+ WriteEraseFail,
+};
+
+#endif
+
--- /dev/null
+\r
+Microsoft Visual Studio Solution File, Format Version 11.00\r
+# Visual C++ Express 2010\r
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "kz_h8write", "kz_h8write.vcxproj", "{C2A6023E-AFED-407F-B679-96F056BAA96A}"\r
+EndProject\r
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "motdump", "motdump.vcxproj", "{8FAD7366-C15B-44F0-956B-2665830B9E8A}"\r
+EndProject\r
+Global\r
+ GlobalSection(SolutionConfigurationPlatforms) = preSolution\r
+ Debug|Win32 = Debug|Win32\r
+ Release|Win32 = Release|Win32\r
+ EndGlobalSection\r
+ GlobalSection(ProjectConfigurationPlatforms) = postSolution\r
+ {C2A6023E-AFED-407F-B679-96F056BAA96A}.Debug|Win32.ActiveCfg = Debug|Win32\r
+ {C2A6023E-AFED-407F-B679-96F056BAA96A}.Debug|Win32.Build.0 = Debug|Win32\r
+ {C2A6023E-AFED-407F-B679-96F056BAA96A}.Release|Win32.ActiveCfg = Release|Win32\r
+ {C2A6023E-AFED-407F-B679-96F056BAA96A}.Release|Win32.Build.0 = Release|Win32\r
+ {8FAD7366-C15B-44F0-956B-2665830B9E8A}.Debug|Win32.ActiveCfg = Debug|Win32\r
+ {8FAD7366-C15B-44F0-956B-2665830B9E8A}.Debug|Win32.Build.0 = Debug|Win32\r
+ {8FAD7366-C15B-44F0-956B-2665830B9E8A}.Release|Win32.ActiveCfg = Release|Win32\r
+ {8FAD7366-C15B-44F0-956B-2665830B9E8A}.Release|Win32.Build.0 = Release|Win32\r
+ EndGlobalSection\r
+ GlobalSection(SolutionProperties) = preSolution\r
+ HideSolutionNode = FALSE\r
+ EndGlobalSection\r
+EndGlobal\r
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>\r
+<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">\r
+ <ItemGroup Label="ProjectConfigurations">\r
+ <ProjectConfiguration Include="Debug|Win32">\r
+ <Configuration>Debug</Configuration>\r
+ <Platform>Win32</Platform>\r
+ </ProjectConfiguration>\r
+ <ProjectConfiguration Include="Release|Win32">\r
+ <Configuration>Release</Configuration>\r
+ <Platform>Win32</Platform>\r
+ </ProjectConfiguration>\r
+ </ItemGroup>\r
+ <PropertyGroup Label="Globals">\r
+ <ProjectGuid>{C2A6023E-AFED-407F-B679-96F056BAA96A}</ProjectGuid>\r
+ <Keyword>Win32Proj</Keyword>\r
+ <RootNamespace>kz_h8write</RootNamespace>\r
+ </PropertyGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">\r
+ <ConfigurationType>Application</ConfigurationType>\r
+ <UseDebugLibraries>true</UseDebugLibraries>\r
+ <CharacterSet>MultiByte</CharacterSet>\r
+ </PropertyGroup>\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">\r
+ <ConfigurationType>Application</ConfigurationType>\r
+ <UseDebugLibraries>false</UseDebugLibraries>\r
+ <WholeProgramOptimization>true</WholeProgramOptimization>\r
+ <CharacterSet>MultiByte</CharacterSet>\r
+ </PropertyGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />\r
+ <ImportGroup Label="ExtensionSettings">\r
+ </ImportGroup>\r
+ <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />\r
+ </ImportGroup>\r
+ <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />\r
+ </ImportGroup>\r
+ <PropertyGroup Label="UserMacros" />\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <LinkIncremental>true</LinkIncremental>\r
+ </PropertyGroup>\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <LinkIncremental>false</LinkIncremental>\r
+ </PropertyGroup>\r
+ <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <ClCompile>\r
+ <PrecompiledHeader>NotUsing</PrecompiledHeader>\r
+ <WarningLevel>Level3</WarningLevel>\r
+ <Optimization>Disabled</Optimization>\r
+ <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>\r
+ <CompileAs>CompileAsCpp</CompileAs>\r
+ <DisableSpecificWarnings>4819;4996;%(DisableSpecificWarnings)</DisableSpecificWarnings>\r
+ <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>\r
+ </ClCompile>\r
+ <Link>\r
+ <SubSystem>Console</SubSystem>\r
+ <GenerateDebugInformation>true</GenerateDebugInformation>\r
+ </Link>\r
+ </ItemDefinitionGroup>\r
+ <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <ClCompile>\r
+ <WarningLevel>Level3</WarningLevel>\r
+ <PrecompiledHeader>NotUsing</PrecompiledHeader>\r
+ <Optimization>MaxSpeed</Optimization>\r
+ <FunctionLevelLinking>true</FunctionLevelLinking>\r
+ <IntrinsicFunctions>true</IntrinsicFunctions>\r
+ <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>\r
+ <CompileAs>CompileAsCpp</CompileAs>\r
+ <DisableSpecificWarnings>4819;4996;%(DisableSpecificWarnings)</DisableSpecificWarnings>\r
+ <RuntimeLibrary>MultiThreaded</RuntimeLibrary>\r
+ </ClCompile>\r
+ <Link>\r
+ <SubSystem>Console</SubSystem>\r
+ <GenerateDebugInformation>true</GenerateDebugInformation>\r
+ <EnableCOMDATFolding>true</EnableCOMDATFolding>\r
+ <OptimizeReferences>true</OptimizeReferences>\r
+ </Link>\r
+ </ItemDefinitionGroup>\r
+ <ItemGroup>\r
+ <ClCompile Include="kz_h8write.c" />\r
+ <ClCompile Include="mot.c" />\r
+ <ClCompile Include="optparse.c" />\r
+ <ClCompile Include="serial_windows.c" />\r
+ </ItemGroup>\r
+ <ItemGroup>\r
+ <ClInclude Include="kz_h8write.h" />\r
+ <ClInclude Include="mot.h" />\r
+ <ClInclude Include="optparse.h" />\r
+ <ClInclude Include="serial.h" />\r
+ </ItemGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />\r
+ <ImportGroup Label="ExtensionTargets">\r
+ </ImportGroup>\r
+</Project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+ <ItemGroup>
+ <Filter Include="ソース ファイル">
+ <UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
+ <Extensions>cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx</Extensions>
+ </Filter>
+ <Filter Include="ヘッダー ファイル">
+ <UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
+ <Extensions>h;hpp;hxx;hm;inl;inc;xsd</Extensions>
+ </Filter>
+ <Filter Include="リソース ファイル">
+ <UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
+ <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
+ </Filter>
+ </ItemGroup>
+ <ItemGroup>
+ <ClCompile Include="kz_h8write.c">
+ <Filter>ソース ファイル</Filter>
+ </ClCompile>
+ <ClCompile Include="mot.c">
+ <Filter>ソース ファイル</Filter>
+ </ClCompile>
+ <ClCompile Include="serial_windows.c">
+ <Filter>ソース ファイル</Filter>
+ </ClCompile>
+ <ClCompile Include="optparse.c">
+ <Filter>ソース ファイル</Filter>
+ </ClCompile>
+ </ItemGroup>
+ <ItemGroup>
+ <ClInclude Include="kz_h8write.h">
+ <Filter>ヘッダー ファイル</Filter>
+ </ClInclude>
+ <ClInclude Include="mot.h">
+ <Filter>ヘッダー ファイル</Filter>
+ </ClInclude>
+ <ClInclude Include="serial.h">
+ <Filter>ヘッダー ファイル</Filter>
+ </ClInclude>
+ <ClInclude Include="optparse.h">
+ <Filter>ヘッダー ファイル</Filter>
+ </ClInclude>
+ </ItemGroup>
+</Project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+</Project>
\ No newline at end of file
--- /dev/null
+/**
+ * @file mot.c
+ * @author Shinichiro Nakamura
+ * @brief motファイルモジュールの実装。
+ */
+
+/*
+ * ===============================================================
+ * mot file interface library
+ * Version 0.0.3
+ * ===============================================================
+ * Copyright (c) 2010-2011 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include "mot.h"
+#include <stdio.h>
+#include <string.h>
+#include <ctype.h>
+
+/**
+ * @brief 文字列に含まれる制御コードを取り除く。
+ * @details
+ * この関数は制御コードを見つけるとNULLに置き換える。
+ * 文字列の途中に制御コードが見つかった場合、
+ * それはNULLとなり文字列の終端となる。
+ * 文字列の途中に制御コードが含まれるケースを今回は
+ * 考慮する必要はない。
+ */
+static void text_trim(char *txt) {
+ const int len = strlen(txt);
+ for (int i = 0; i < len; i++) {
+ if ((txt[i] == '\r') || (txt[i] == '\n') || (txt[i] == '\t')) {
+ txt[i] = '\0';
+ }
+ }
+}
+
+/**
+ * @brief 与えられた文字を１６進数として解釈し値を得る。
+ * @param c 文字。
+ * @retval 0以上 値。
+ * @retval 負値 エラー。
+ */
+static unsigned int get_hex_num(const char c) {
+ static const char *hextxt = "0123456789ABCDEF";
+ for (int i = 0; i < 16; i++) {
+ if (c == hextxt[i]) {
+ return i;
+ }
+ }
+ return -1;
+}
+
+/**
+ * @brief １レコードをパースする。
+ * @param p mot構造体。(コールバック関数などの情報を参照する。)
+ * @param txt １レコード。
+ * @retval 0 成功
+ * @retval 0以外 エラー番号。
+ */
+static int parse_record(mot_t *p, const char *txt)
+{
+ unsigned char buf[BUFSIZ];
+
+ /*
+ * 与えられた文字列は少なくとも４バイト長なければおかしい。
+ */
+ const int txtlen = strlen(txt);
+ if (txtlen < 4) {
+ return -1;
+ }
+
+ /*
+ * 最初の文字は必ずSでなければならない。
+ */
+ if (txt[0] != 'S') {
+ return -2;
+ }
+
+ /*
+ * 次の文字はレコードタイプである。
+ */
+ if (!isdigit(txt[1])) {
+ return -3;
+ }
+
+ /*
+ * その次の２バイトはレコードに含まれるアドレスからチェックサムまでのデータバイト数である。
+ * ここでバイト数とテキスト長を比較して正当なレコードであることを検証する。
+ */
+ const int datlen = (get_hex_num(txt[2]) * 0x10) + (get_hex_num(txt[3] * 0x01));
+ if ((datlen * 2) != txtlen - 4) {
+ return -4;
+ }
+
+ /*
+ * チェックサムを検証する。
+ * チェックサムはデータ長からチェックサムの前までの加算に対して１の補数をとったものである。
+ *
+ * 1. チェックサムの計算とデータの格納を行う。
+ * 2. チェックサムの妥当性を検証する。
+ *
+ * 同時に内部バッファ(buf)にデータをコピーする。
+ * 内部バッファ(buf)にはデータバイト数以降のデータが格納される。
+ */
+ unsigned char chksum = datlen;
+ for (int i = 0; i < datlen; i++) {
+ buf[i] = (get_hex_num(txt[4 + (i * 2)]) * 0x10) + (get_hex_num(txt[5 + (i * 2)] * 0x01));
+ if (i < datlen - 1) {
+ chksum += buf[i];
+ }
+ }
+ unsigned char verify = ~buf[datlen - 1];
+ if (chksum != verify) {
+ return -5;
+ }
+
+ /*
+ * 全てが妥当なデータと見なせる。
+ * よってコールバックを呼び出す。
+ * ここでレコードの種類によって呼び出す関数を分けることもできる。
+ *
+ * この関数に渡された元データのゼロから数えて第１バイト目がレコードの種類を示している。
+ */
+ switch (txt[1]) {
+ case '0':
+ /*
+ * スタートレコード。
+ */
+ // @todo 必要になったら実装する。
+ break;
+ case '1':
+ /*
+ * データレコード。(16ビットアドレスデータ)
+ */
+ if (p->cb_data != NULL) {
+ unsigned int addr =
+ (buf[0] * 0x00000100) +
+ (buf[1] * 0x00000001);
+ p->cb_data(addr, buf + 2, datlen - 2 - 1);
+ }
+ break;
+ case '2':
+ /*
+ * データレコード。(24ビットアドレスデータ)
+ */
+ if (p->cb_data != NULL) {
+ unsigned int addr =
+ (buf[0] * 0x00010000) +
+ (buf[1] * 0x00000100) +
+ (buf[2] * 0x00000001);
+ p->cb_data(addr, buf + 3, datlen - 3 - 1);
+ }
+ break;
+ case '3':
+ /*
+ * データレコード。(32ビットアドレスデータ)
+ */
+ if (p->cb_data != NULL) {
+ unsigned int addr =
+ (buf[0] * 0x01000000) +
+ (buf[1] * 0x00010000) +
+ (buf[2] * 0x00000100) +
+ (buf[3] * 0x00000001);
+ p->cb_data(addr, buf + 4, datlen - 4 - 1);
+ }
+ break;
+ case '4':
+ /*
+ * シンボルレコード。
+ */
+ // @todo 必要になったら実装する。
+ break;
+ case '5':
+ /*
+ * データレコード数。
+ */
+ // @todo 必要になったら実装する。
+ break;
+ case '6':
+ /*
+ * 未使用。
+ */
+ // @todo 必要になったら実装する。
+ break;
+ case '7':
+ /*
+ * データレコード終了。(32ビットアドレスデータ)
+ */
+ // @todo 必要になったら実装する。
+ break;
+ case '8':
+ /*
+ * データレコード終了。(24ビットアドレスデータ)
+ */
+ // @todo 必要になったら実装する。
+ break;
+ case '9':
+ /*
+ * データレコード終了。(16ビットアドレスデータ)
+ */
+ // @todo 必要になったら実装する。
+ break;
+ default:
+ /*
+ * 不明なデータ。
+ */
+ break;
+ }
+
+ return 0;
+}
+
+/**
+ * @brief motファイルを読み込む。
+ *
+ * @param filename ファイル名。(NULLを与えると標準入力を入力とする。)
+ * @param p mot構造体。(コールバック関数などの情報を参照する。)
+ *
+ * @retval 0 成功
+ * @retval 0以外 エラー番号。
+ */
+int mot_read(const char *filename, mot_t *p)
+{
+ char buf[BUFSIZ];
+ FILE *fp = NULL;
+
+ if (filename == NULL) {
+ /*
+ * 標準入力を入力用ファイルとして用いる。
+ */
+ fp = stdin;
+ if (fp == NULL) {
+ return -1;
+ }
+ } else {
+ /*
+ * ファイルをオープンする。
+ */
+ fp = fopen(filename, "r");
+ if (fp == NULL) {
+ return -1;
+ }
+ }
+
+ /*
+ * レコードを１つずつ読み込んでパースする。
+ */
+ while (fgets(buf, sizeof(buf), fp)) {
+ const int len = strlen(buf);
+ if (len > 0) {
+ text_trim(buf);
+ if (parse_record(p, buf) != 0) {
+ fclose(fp);
+ return -2;
+ }
+ }
+ }
+
+ /*
+ * ファイルをクローズする。
+ */
+ fclose(fp);
+ return 0;
+}
+
--- /dev/null
+/**
+ * @file mot.h
+ * @author Shinichiro Nakamura
+ * @brief motファイルモジュールのインターフェース定義。
+ */
+
+/*
+ *
+ * ===============================================================
+ * mot file interface library
+ * Version 0.0.3
+ * ===============================================================
+ * Copyright (c) 2010-2011 Shinichiro Nakamura
+ *
+ * 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 MOT_H
+#define MOT_H
+
+typedef struct {
+ void (*cb_data)(const unsigned int addr, const unsigned char *buf, const int siz);
+} mot_t;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief motファイルを読み込む。
+ *
+ * @param filename ファイル名。(NULLを与えると標準入力を入力とする。)
+ * @param p mot構造体。(コールバック関数などの情報を参照する。)
+ *
+ * @retval 0 成功
+ * @retval 0以外 エラー番号。
+ */
+int mot_read(const char *filename, mot_t *p);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+
--- /dev/null
+/**
+ * @file motdump.c
+ * @author Shinichiro Nakamura
+ * @brief motファイルダンププログラムの実装。
+ */
+
+/*
+ * ===============================================================
+ * mot dump utility
+ * Version 0.0.3
+ * ===============================================================
+ * Copyright (c) 2010-2011 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include <stdio.h>
+#include <ctype.h>
+#include "mot.h"
+
+unsigned char memory_image[0x100000 + 0x100];
+unsigned int memory_lastaddr = 0;
+
+void cb_data(
+ const unsigned int addr,
+ const unsigned char *buf,
+ const int siz)
+{
+ for (int i = 0; i < siz; i++) {
+ memory_image[addr + i] = buf[i];
+ }
+ if (memory_lastaddr < addr) {
+ memory_lastaddr = addr;
+ }
+}
+
+/**
+ * @brief 1行に表示する桁数。
+ */
+#define COLSIZ 16
+
+/**
+ * @brief 切り上げ処理。
+ * @details 数値AをBで切り上げる。
+ */
+#define ROUND_OUT(A,B) ((((A)+((B)-1))/(B))*(B))
+
+/**
+ * @brief エントリポイント。
+ */
+int main(int argc, char **argv) {
+ if (argc != 2) {
+ printf("%s [filename]\n", argv[0]);
+ return 1;
+ }
+ mot_t mot;
+ mot.cb_data = cb_data;
+ if (mot_read(argv[1], &mot) == 0) {
+ unsigned char cbuf[COLSIZ];
+ unsigned int ccnt = 0;
+ for (unsigned int addr = 0; addr < ROUND_OUT(memory_lastaddr, COLSIZ); addr++) {
+ /*
+ * 行頭表示処理。
+ */
+ if ((addr % COLSIZ) == 0) {
+ printf("\n");
+ printf("0x%04X :", addr);
+ }
+ /*
+ * データ表示処理。
+ */
+ printf(" %02X", memory_image[addr] & 0xff);
+ cbuf[addr % COLSIZ] = memory_image[addr] & 0xff;
+ ccnt++;
+ /*
+ * 行端表示処理。
+ */
+ if (((addr + 1) % COLSIZ) == 0) {
+ if (ccnt > 0) {
+ printf(" | ");
+ for (int i = 0; i < COLSIZ; i++) {
+ if (i < (int)ccnt) {
+ printf("%c", isprint(cbuf[i] & 0xff)
+ ? (cbuf[i] & 0xff) : '.');
+ } else {
+ printf(" ");
+ }
+ }
+ }
+ ccnt = 0;
+ }
+ }
+ } else {
+ printf("Read failed.\n");
+ }
+ printf("\n");
+ return 0;
+}
+
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>\r
+<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">\r
+ <ItemGroup Label="ProjectConfigurations">\r
+ <ProjectConfiguration Include="Debug|Win32">\r
+ <Configuration>Debug</Configuration>\r
+ <Platform>Win32</Platform>\r
+ </ProjectConfiguration>\r
+ <ProjectConfiguration Include="Release|Win32">\r
+ <Configuration>Release</Configuration>\r
+ <Platform>Win32</Platform>\r
+ </ProjectConfiguration>\r
+ </ItemGroup>\r
+ <PropertyGroup Label="Globals">\r
+ <ProjectGuid>{8FAD7366-C15B-44F0-956B-2665830B9E8A}</ProjectGuid>\r
+ <Keyword>Win32Proj</Keyword>\r
+ <RootNamespace>motdump</RootNamespace>\r
+ </PropertyGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">\r
+ <ConfigurationType>Application</ConfigurationType>\r
+ <UseDebugLibraries>true</UseDebugLibraries>\r
+ <CharacterSet>Unicode</CharacterSet>\r
+ </PropertyGroup>\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">\r
+ <ConfigurationType>Application</ConfigurationType>\r
+ <UseDebugLibraries>false</UseDebugLibraries>\r
+ <WholeProgramOptimization>true</WholeProgramOptimization>\r
+ <CharacterSet>Unicode</CharacterSet>\r
+ </PropertyGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />\r
+ <ImportGroup Label="ExtensionSettings">\r
+ </ImportGroup>\r
+ <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />\r
+ </ImportGroup>\r
+ <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />\r
+ </ImportGroup>\r
+ <PropertyGroup Label="UserMacros" />\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <LinkIncremental>true</LinkIncremental>\r
+ </PropertyGroup>\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <LinkIncremental>false</LinkIncremental>\r
+ </PropertyGroup>\r
+ <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <ClCompile>\r
+ <PrecompiledHeader>NotUsing</PrecompiledHeader>\r
+ <WarningLevel>Level3</WarningLevel>\r
+ <Optimization>Disabled</Optimization>\r
+ <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>\r
+ <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>\r
+ <DisableSpecificWarnings>4819;4996;%(DisableSpecificWarnings)</DisableSpecificWarnings>\r
+ <CompileAs>CompileAsCpp</CompileAs>\r
+ </ClCompile>\r
+ <Link>\r
+ <SubSystem>Console</SubSystem>\r
+ <GenerateDebugInformation>true</GenerateDebugInformation>\r
+ </Link>\r
+ </ItemDefinitionGroup>\r
+ <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <ClCompile>\r
+ <WarningLevel>Level3</WarningLevel>\r
+ <PrecompiledHeader>NotUsing</PrecompiledHeader>\r
+ <Optimization>MaxSpeed</Optimization>\r
+ <FunctionLevelLinking>true</FunctionLevelLinking>\r
+ <IntrinsicFunctions>true</IntrinsicFunctions>\r
+ <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>\r
+ <RuntimeLibrary>MultiThreaded</RuntimeLibrary>\r
+ <DisableSpecificWarnings>4819;4996;%(DisableSpecificWarnings)</DisableSpecificWarnings>\r
+ <CompileAs>CompileAsCpp</CompileAs>\r
+ </ClCompile>\r
+ <Link>\r
+ <SubSystem>Console</SubSystem>\r
+ <GenerateDebugInformation>true</GenerateDebugInformation>\r
+ <EnableCOMDATFolding>true</EnableCOMDATFolding>\r
+ <OptimizeReferences>true</OptimizeReferences>\r
+ </Link>\r
+ </ItemDefinitionGroup>\r
+ <ItemGroup>\r
+ <ClCompile Include="mot.c" />\r
+ <ClCompile Include="motdump.c" />\r
+ </ItemGroup>\r
+ <ItemGroup>\r
+ <ClInclude Include="mot.h" />\r
+ </ItemGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />\r
+ <ImportGroup Label="ExtensionTargets">\r
+ </ImportGroup>\r
+</Project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+ <ItemGroup>
+ <Filter Include="ソース ファイル">
+ <UniqueIdentifier>{8890379f-7d7f-4aa3-8f66-634061d6b761}</UniqueIdentifier>
+ </Filter>
+ <Filter Include="ヘッダー ファイル">
+ <UniqueIdentifier>{c3b12a91-0bb1-442b-92e0-d010434789b2}</UniqueIdentifier>
+ </Filter>
+ </ItemGroup>
+ <ItemGroup>
+ <ClCompile Include="mot.c">
+ <Filter>ソース ファイル</Filter>
+ </ClCompile>
+ <ClCompile Include="motdump.c">
+ <Filter>ソース ファイル</Filter>
+ </ClCompile>
+ </ItemGroup>
+ <ItemGroup>
+ <ClInclude Include="mot.h">
+ <Filter>ヘッダー ファイル</Filter>
+ </ClInclude>
+ </ItemGroup>
+</Project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+</Project>
\ No newline at end of file
--- /dev/null
+/**
+ * @file optparse.c
+ * @author Shinichiro Nakamura
+ * @brief オプション解析モジュールの実装。
+ */
+
+/*
+ * ===============================================================
+ * Option parse library
+ * Version 0.0.1
+ * ===============================================================
+ * Copyright (c) 2012 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include <string.h>
+#include "optparse.h"
+
+int optparse_char(
+ int argc,
+ char **argv,
+ void *extobj,
+ int (*callback)(
+ const char option, const char *argument, void *extobj))
+{
+ for (int i = 1; i < argc;) {
+ int r = 0;
+ int c = 0;
+ if (argv[i][0] == '-') {
+ /*
+ * 与えられた文字列は引数である。
+ */
+ if (strlen(argv[i]) > 2) {
+ /*
+ * 同じ箇所にアーギュメントが指定されている。
+ */
+ r = callback(argv[i][1], &argv[i][2], extobj);
+ c = 1;
+ } else {
+ if ((i + 1) < argc) {
+ /*
+ * まだ続きがありそうだ。
+ * 先を見ておこう。
+ */
+ if (argv[i + 1][0] == '-') {
+ /*
+ * その引数にアーギュメントはない。
+ */
+ r = callback(argv[i][1], "", extobj);
+ c = 1;
+ } else {
+ /*
+ * その引数にアーギュメントがある。
+ */
+ r = callback(argv[i][1], argv[i + 1], extobj);
+ c = 2;
+ }
+ } else {
+ /*
+ * もう先がない。
+ * ということはアーギュメントはない。
+ */
+ r = callback(argv[i][1], "", extobj);
+ c = 1;
+ }
+ }
+ } else {
+ /*
+ * 与えられた文字列はオプションでない
+ * 単独アーギュメントである。
+ */
+ r = callback('\x00', &argv[i][0], extobj);
+ c = 1;
+ }
+ i += c;
+ if (r != 0) {
+ break;
+ }
+ }
+ return 0;
+}
+
+int optparse_text(
+ int argc,
+ char **argv,
+ void *extobj,
+ int (*callback)(
+ const char *option, const char *argument, void *extobj))
+{
+ for (int i = 1; i < argc;) {
+ int r = 0;
+ int c = 0;
+ if (argv[i][0] == '-') {
+ /*
+ * 与えられた文字列は引数である。
+ */
+ if ((i + 1) < argc) {
+ /*
+ * まだ続きがありそうだ。
+ * 先を見ておこう。
+ */
+ if (argv[i + 1][0] == '-') {
+ /*
+ * その引数にアーギュメントはない。
+ */
+ r = callback(&argv[i][1], "", extobj);
+ c = 1;
+ } else {
+ /*
+ * その引数にアーギュメントがある。
+ */
+ r = callback(&argv[i][1], argv[i + 1], extobj);
+ c = 2;
+ }
+ } else {
+ /*
+ * もう先がない。
+ * ということはアーギュメントはない。
+ */
+ r = callback(&argv[i][1], "", extobj);
+ c = 1;
+ }
+ } else {
+ /*
+ * 与えられた文字列はオプションでない
+ * 単独アーギュメントである。
+ */
+ r = callback("", &argv[i][0], extobj);
+ c = 1;
+ }
+ i += c;
+ if (r != 0) {
+ break;
+ }
+ }
+ return 0;
+}
+
--- /dev/null
+/**
+ * @file optparse.h
+ * @author Shinichiro Nakamura
+ * @brief オプション解析モジュールの定義。
+ */
+
+/*
+ * ===============================================================
+ * Option parse library
+ * Version 0.0.1
+ * ===============================================================
+ * Copyright (c) 2012 Shinichiro Nakamura
+ *
+ * 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 OPTPARSE_H
+#define OPTPARSE_H
+
+int optparse_char(
+ int argc,
+ char **argv,
+ void *extobj,
+ int (*callback)(
+ const char option, const char *argument, void *extobj));
+
+int optparse_text(
+ int argc,
+ char **argv,
+ void *extobj,
+ int (*callback)(
+ const char *option, const char *argument, void *extobj));
+
+#endif
+
--- /dev/null
+/**
+ * @file serial.h
+ * @author Shinichiro Nakamura
+ * @brief シリアルポートドライバのインターフェース定義。
+ */
+
+/*
+ * ===============================================================
+ * Serial interface library
+ * Version 0.0.4
+ * ===============================================================
+ * Copyright (c) 2010-2012 Shinichiro Nakamura
+ *
+ * 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 SERIAL_H
+#define SERIAL_H
+
+#include <stdio.h>
+
+typedef struct serial SERIAL;
+
+/**
+ * @brief ボーレート.
+ */
+enum SerialBaud {
+ SerialBaud2400,
+ SerialBaud4800,
+ SerialBaud9600,
+ SerialBaud19200,
+ SerialBaud38400
+};
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * シリアルポートをオープンする.
+ *
+ * @param devfile シリアルポートのデバイスファイル名.
+ * @param baud ボーレート.
+ *
+ * @retval !NULL ハンドラ。
+ * @retval NULL 失敗。
+ */
+SERIAL *serial_open(const char *devfile, const enum SerialBaud baud);
+
+/**
+ * シリアルポートをクローズする.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_close(SERIAL * s);
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read(SERIAL * s, unsigned char *buf, const size_t size);
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ * @param ms ミリ秒単位のタイムアウト時間.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read_with_timeout(
+ SERIAL * s, unsigned char *buf, const size_t size, const int ms);
+
+/**
+ * シリアルポートへ指定バイト数の書き込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 書き込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_write(SERIAL * s, const unsigned char *buf, const size_t size);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
--- /dev/null
+/**
+ * @file serial_linux.c
+ * @author Shinichiro Nakamura
+ * @brief シリアルポートドライバの実装。(Linuxプラットフォーム用)
+ */
+
+/*
+ * ===============================================================
+ * Serial interface library
+ * Version 0.0.4
+ * ===============================================================
+ * Copyright (c) 2010-2012 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdarg.h>
+#include <string.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <poll.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <termios.h>
+#include <limits.h>
+#include <pthread.h>
+#include "serial.h"
+
+#define MUTEX_INIT() pthread_mutex_init(&(s->mutex), NULL)
+#define MUTEX_LOCK() pthread_mutex_lock(&(s->mutex))
+#define MUTEX_UNLOCK() pthread_mutex_unlock(&(s->mutex))
+
+struct serial {
+ char devfile[BUFSIZ];
+ int fd;
+ struct termios termios_old;
+ struct termios termios_new;
+ pthread_mutex_t mutex;
+};
+
+/**
+ * シリアルポートをオープンする.
+ *
+ * @param devfile シリアルポートのデバイスファイル名.
+ * @param baud ボーレート.
+ *
+ * @retval !NULL ハンドラ。
+ * @retval NULL 失敗。
+ */
+SERIAL *serial_open(const char *devfile, const enum SerialBaud baud)
+{
+ int baudrate = 0;
+
+ /*
+ * シリアルデスクリプタの管理領域を確保する.
+ */
+ SERIAL *s = (SERIAL *) malloc(sizeof(SERIAL));
+ if (s == NULL) {
+ return NULL;
+ }
+
+ /*
+ * ミューテックスを初期化する.
+ */
+ MUTEX_INIT();
+
+ /*
+ * ポートを開く.
+ */
+ strcpy(s->devfile, devfile);
+ s->fd = open(devfile, O_RDWR | O_NOCTTY | O_NDELAY);
+ if (s->fd < 0) {
+ free(s);
+ return NULL;
+ }
+
+ /*
+ * ポート設定を退避する.
+ */
+ tcgetattr(s->fd, &(s->termios_old));
+
+ /*
+ * ポート設定を初期化する.
+ */
+ memset(&(s->termios_new), 0x00, sizeof(s->termios_new));
+
+ /*
+ * Bxxxxx : ボーレートの設定．cfsetispeed と cfsetospeed も使用できる
+ * CS8 : 8n1 (8 ビット，ノンパリティ，ストップビット 1)
+ * CLOCAL : ローカル接続，モデム制御なし
+ * CREAD : 受信文字(receiving characters)を有効にする
+ */
+ s->termios_new.c_cflag = CS8 | CLOCAL | CREAD;
+ switch (baud) {
+ case SerialBaud2400:
+ s->termios_new.c_cflag |= B2400;
+ baudrate = 2400;
+ break;
+ case SerialBaud4800:
+ s->termios_new.c_cflag |= B4800;
+ baudrate = 4800;
+ break;
+ case SerialBaud9600:
+ s->termios_new.c_cflag |= B9600;
+ baudrate = 9600;
+ break;
+ case SerialBaud19200:
+ s->termios_new.c_cflag |= B19200;
+ baudrate = 19200;
+ break;
+ case SerialBaud38400:
+ s->termios_new.c_cflag |= B38400;
+ baudrate = 38400;
+ break;
+ default:
+ s->termios_new.c_cflag |= B9600;
+ baudrate = 9600;
+ break;
+ }
+ cfsetispeed(&(s->termios_new), baudrate);
+ cfsetospeed(&(s->termios_new), baudrate);
+
+ /*
+ * IGNPAR : パリティエラーのデータは無視する
+ */
+ s->termios_new.c_iflag = IGNPAR;
+
+ /*
+ * Raw モードでの出力
+ */
+ s->termios_new.c_oflag = 0;
+
+ /*
+ * 入力モードをノンカノニカル、ノンエコーに設定する
+ */
+ s->termios_new.c_lflag = 0;
+
+ /*
+ * モデムラインをクリアし，ポートの設定を有効にする
+ */
+ tcflush(s->fd, TCIFLUSH);
+ tcsetpgrp(s->fd, getpgrp());
+ tcsetattr(s->fd, TCSANOW, &(s->termios_new));
+
+ return s;
+}
+
+/**
+ * シリアルポートをクローズする.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_close(SERIAL * s)
+{
+ /*
+ * ポート設定を元に戻す.
+ */
+ tcsetattr(s->fd, TCSANOW, &(s->termios_old));
+
+ /*
+ * ポートを閉じる.
+ */
+ close(s->fd);
+
+ /*
+ * シリアルデスクリプタの管理領域を破棄する.
+ */
+ free(s);
+
+ return 0;
+}
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read(SERIAL * s, unsigned char *buf, const size_t size)
+{
+ int e = 0;
+ int rcvcnt = 0;
+
+ MUTEX_LOCK();
+
+ /*
+ * 読み込みを実行する.
+ */
+ while (rcvcnt < size) {
+ int r = read(s->fd, buf + rcvcnt, size - rcvcnt);
+ if (r < 0) {
+ e = 1;
+ break;
+ }
+ rcvcnt += r;
+ }
+
+ MUTEX_UNLOCK();
+
+ return e;
+}
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ * @param ms ミリ秒単位のタイムアウト時間.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read_with_timeout(SERIAL * s,
+ unsigned char *buf, const size_t size, const int ms)
+{
+ int e = 0;
+ int i;
+
+ MUTEX_LOCK();
+
+ /*
+ * タイムアウトを設定して読み込みを実行する.
+ */
+ for (i = 0; i < (int) size; i++) {
+ struct pollfd fds;
+ fds.fd = s->fd;
+ fds.events = POLLIN;
+ poll(&fds, 1, ms);
+ if (fds.revents & POLLIN) {
+ /*
+ * 1バイトの読み込みを実行.
+ */
+ int r = read(s->fd, buf + i, 1);
+ if (r < 0) {
+ e = 1;
+ break;
+ }
+ } else {
+ /*
+ * タイムアウトが発生した.
+ */
+ e = 2;
+ break;
+ }
+ }
+
+ MUTEX_UNLOCK();
+
+ return e;
+}
+
+/**
+ * シリアルポートへ指定バイト数の書き込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 書き込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_write(SERIAL * s,
+ const unsigned char *buf, const size_t size)
+{
+ int e = 0;
+ int sndcnt = 0;
+
+ MUTEX_LOCK();
+
+ while (sndcnt < size) {
+ int r = write(s->fd, buf + sndcnt, size - sndcnt);
+ if (r < 0) {
+ e = 1;
+ break;
+ }
+ sndcnt += r;
+ }
+
+ MUTEX_UNLOCK();
+
+ return e;
+}
+
--- /dev/null
+/**
+ * @file serial_windows.c
+ * @author Shinichiro Nakamura
+ * @brief シリアルポートドライバの実装。(Windowsプラットフォーム用)
+ */
+
+/*
+ * ===============================================================
+ * Serial interface library
+ * Version 0.0.4
+ * ===============================================================
+ * Copyright (c) 2010-2012 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include <stdio.h>
+#include <Windows.h>
+#include <WinBase.h>
+#include "serial.h"
+
+struct serial {
+ char devfile[BUFSIZ];
+ HANDLE handle;
+};
+
+/**
+ * シリアルポートをオープンする.
+ *
+ * @param devfile シリアルポートのデバイスファイル名.
+ * @param baud ボーレート.
+ *
+ * @retval !NULL ハンドラ。
+ * @retval NULL 失敗。
+ */
+SERIAL *serial_open(const char *devfile, const enum SerialBaud baud)
+{
+ DCB param;
+ int baudrate = 0;
+
+ /*
+ * シリアルデスクリプタの管理領域を確保する.
+ */
+ SERIAL *s = (SERIAL *) malloc(sizeof(SERIAL));
+ if (s == NULL) {
+ return NULL;
+ }
+
+ /*
+ * ポート名を決定する.
+ */
+ if (strstr(devfile, "\\\\.\\") == NULL) {
+ strcpy(s->devfile, "\\\\.\\");
+ } else {
+ strcpy(s->devfile, "");
+ }
+ strcat(s->devfile, devfile);
+
+ /*
+ * ポートを開く.
+ */
+ s->handle = CreateFile(
+ s->devfile,
+ GENERIC_READ | GENERIC_WRITE,
+ 0,
+ NULL,
+ OPEN_EXISTING,
+ 0,
+ NULL);
+ if (s->handle == INVALID_HANDLE_VALUE) {
+ free(s);
+ return NULL;
+ }
+
+ /*
+ * ポートの設定を行う。
+ */
+ if (!GetCommState(s->handle, ¶m)) {
+ free(s);
+ return NULL;
+ }
+ switch (baud) {
+ case SerialBaud2400:
+ param.BaudRate = CBR_2400;
+ break;
+ case SerialBaud4800:
+ param.BaudRate = CBR_4800;
+ break;
+ case SerialBaud9600:
+ param.BaudRate = CBR_9600;
+ break;
+ case SerialBaud19200:
+ param.BaudRate = CBR_19200;
+ break;
+ case SerialBaud38400:
+ param.BaudRate = CBR_38400;
+ break;
+ default:
+ param.BaudRate = CBR_9600;
+ break;
+ }
+ param.ByteSize = 8;
+ param.StopBits = ONESTOPBIT;
+ param.Parity = NOPARITY;
+ if(!SetCommState(s->handle, ¶m)){
+ free(s);
+ return NULL;
+ }
+
+ /*
+ * バッファの内容を捨てる.
+ */
+ PurgeComm(s->handle, PURGE_RXCLEAR);
+ PurgeComm(s->handle, PURGE_TXCLEAR);
+ PurgeComm(s->handle, PURGE_RXABORT);
+ PurgeComm(s->handle, PURGE_TXABORT);
+
+ return s;
+}
+
+/**
+ * シリアルポートをクローズする.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_close(SERIAL * s)
+{
+
+ /*
+ * バッファの内容を捨てる.
+ */
+ PurgeComm(s->handle, PURGE_RXCLEAR);
+ PurgeComm(s->handle, PURGE_TXCLEAR);
+ PurgeComm(s->handle, PURGE_RXABORT);
+ PurgeComm(s->handle, PURGE_TXABORT);
+
+ /*
+ * ポートを閉じる.
+ */
+ CloseHandle(s->handle);
+
+ /*
+ * シリアルデスクリプタの管理領域を破棄する.
+ */
+ free(s);
+
+ return 0;
+}
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read(SERIAL * s, unsigned char *buf, const size_t size)
+{
+ int e = 0;
+ DWORD cnt;
+
+ /*
+ * 読み込みを実行する.
+ */
+ if(!ReadFile(s->handle, buf, size, &cnt, NULL)){
+ e = 1;
+ }
+
+ return e;
+}
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ * @param ms ミリ秒単位のタイムアウト時間.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read_with_timeout(SERIAL * s,
+ unsigned char *buf, const size_t size, const int ms)
+{
+ int e = 0;
+ DWORD total = 0;
+
+ /*
+ * タイムアウトを設定して読み込みを実行する.
+ */
+ COMMTIMEOUTS cto;
+ cto.ReadIntervalTimeout = MAXDWORD;
+ cto.ReadTotalTimeoutConstant = ms;
+ cto.ReadTotalTimeoutMultiplier = MAXDWORD;
+ if(SetCommTimeouts(s->handle, &cto)){
+ /*
+ * 読み込みを実行する.
+ */
+ while (total < size) {
+ DWORD cnt = 0;
+ ReadFile(s->handle, buf + total, 1, &cnt, NULL);
+ if (cnt != 1) {
+ e = 2;
+ break;
+ }
+ total += cnt;
+ }
+ } else {
+ /*
+ * タイムアウトの設定に失敗した。
+ */
+ e = 1;
+ }
+
+ return e;
+}
+
+/**
+ * シリアルポートへ指定バイト数の書き込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 書き込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_write(SERIAL * s,
+ const unsigned char *buf, const size_t size)
+{
+ int e = 0;
+ DWORD cnt;
+
+ /*
+ * 書き込みを実行する.
+ */
+ if(!WriteFile(s->handle, buf, size, &cnt, NULL)){
+ e = 1;
+ }
+
+ return e;
+}
+
--- /dev/null
+# Doxyfile 1.7.1
+
+# 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 = "XMODEM for KOZOS H8/3069F"
+
+# 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.0.2
+
+# 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 = doc
+
+# 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 = Japanese
+
+# 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 = YES
+
+# 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 =
+
+# 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 = NO
+
+# 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, CSharp, 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 = NO
+
+# 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 FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# 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_MEMBERS_CTORS_1ST tag is set to YES then doxygen
+# will sort the (brief and detailed) documentation of class members so that
+# constructors and destructors are listed first. If set to NO (the default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = 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 = 24
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# 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 <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> 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 = YES
+
+# 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 = .
+
+# 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 <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> 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 = YES
+
+# 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 = YES
+
+# 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 =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
+# Doxygen will adjust the colors in the stylesheet and background images
+# according to this color. Hue is specified as an angle on a colorwheel,
+# see http://en.wikipedia.org/wiki/Hue for more information.
+# For instance the value 0 represents red, 60 is yellow, 120 is green,
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
+# The allowed range is 0 to 359.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
+# the colors in the HTML output. For a value of 0 the output will use
+# grayscales only. A value of 255 will produce the most vivid colors.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
+# the luminance component of the colors in the HTML output. Values below
+# 100 gradually make the output lighter, whereas values above 100 make
+# the output darker. The value divided by 100 is the actual gamma applied,
+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
+# and 100 does not change the gamma.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP = YES
+
+# 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
+
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# 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 = org.doxygen.Project
+
+# 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
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+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 =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+# will be generated, which together with the HTML files, form an Eclipse help
+# plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
+# the help appears.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# 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 YES, 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 (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW = YES
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES = NO
+
+# 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
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
+# links to external symbols imported via tag files in a separate window.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# 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
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are
+# not supported properly for IE 6.0, but are supported on all modern browsers.
+# Note that when changing this option you need to delete any form_*.png files
+# in the HTML output before the changes have effect.
+
+FORMULA_TRANSPARENT = YES
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
+# for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using
+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
+# (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a PHP enabled web server instead of at the web client
+# using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server
+# based approach is that it scales better to large projects and allows
+# full text search. The disadvances is that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH = NO
+
+#---------------------------------------------------------------------------
+# 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.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+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 = YES
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS = 0
+
+# 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.ttf
+
+# 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 = YES
+
+# 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 = YES
+
+# 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 = YES
+
+# 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
--- /dev/null
+kz_xmodem: kz_xmodem.c kz_xmodem.h serial_linux.c serial.h
+ $(CC) -o $@ serial_linux.c kz_xmodem.c -std=c99 -g -Wall
+
+clean:
+ @rm -f kz_xmodem
--- /dev/null
+
+=====================================================================
+ XMODEM for KOZOS H8/3069F
+ Copyright(C) 2012 Shinichiro Nakamura
+=====================================================================
+
+ XMODEM for KOZOS H8/3069FはKOZOSブートローダ経由で
+ OSを書き込んでいるのだけど、ちょくちょく転送に失敗するので
+ 作業効率が悪くてモチベーションが下がっている方の為の転送用ツールです。
+
+ /doc
+ README.txt このファイル
+ /example
+ kozos 動作確認用サンプルデータ
+ KOZOSのブートローダ経由で転送します。
+ /src
+ Makefile メイクファイル
+ kz_xmodem.c 本体ソースコード
+ kz_xmodem.h 本体に対する定義
+ serial_linux.c シリアルポートライブラリの実装(Linux)
+ serial_windows.c シリアルポートライブラリの実装(Windows)
+ serial.h シリアルポートライブラリのインターフェース
+
+=====================================================================
+ 特徴
+=====================================================================
+
+ KOZOSのXMODEM実装に合わせて実装したXMODEM。
+ KOZOSのブートローダのloadコマンドを内部で自動発行。
+ リセットボタンを押して本プログラムを実行するだけの簡単操作。
+
+=====================================================================
+ 使い方
+=====================================================================
+
+ motファイル名、書き込みインターフェースを与えて実行します。
+
+ 例) kz_xmodem kozos /dev/ttyUSB0
+
+ 書き込みに成功した場合、実行表示の最後にComplete.と表示されます。
+
+=====================================================================
+ 出力例
+=====================================================================
+
+ (Windows)
+
+ > kz_xmodem.exe kozos com5
+
+ =================================================
+ XMODEM for KOZOS H8/3069F (Version 0.0.1)
+ Copyright(C) 2012 Shinichiro Nakamura
+ =================================================
+ Flushing serial port.
+ Wait.
+ Setup load condition.
+ Wait a NAK.
+ ..........
+ Transmit the target ELF file.
+ File(kozos): 24 blocks + 44 bytes
+ .........................
+ Wait a message from the target.
+ Complete.
+
+ (Linux)
+
+ > kz_xmodem kozos /dev/ttyUSB0
+
+ =================================================
+ XMODEM for KOZOS H8/3069F (Version 0.0.1)
+ Copyright(C) 2012 Shinichiro Nakamura
+ =================================================
+ Flushing serial port.
+ Wait.
+ Setup load condition.
+ Wait a NAK.
+ .........
+ Transmit the target ELF file.
+ File(kozos): 24 blocks + 44 bytes
+ .........................
+ Wait a message from the target.
+ Complete.
+
+=====================================================================
+ バージョン
+=====================================================================
+
+ 2012/04/28 Version 0.0.1 初版
+ 2012/04/30 Version 0.0.2 転送サイズの計算バグを修正した。
+
--- /dev/null
+/**
+ * @file kz_xmodem.c
+ * @author Shinichiro Nakamura
+ * @brief XMODEM for KOZOS.
+ */
+
+/*
+ * ===============================================================
+ * XMODEM for KOZOS
+ * Version 0.0.2
+ * ===============================================================
+ * Copyright (c) 2012 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include <stdio.h>
+#include <string.h>
+#include "serial.h"
+#include "kz_xmodem.h"
+
+#ifdef WIN32
+# include <windows.h>
+# define SLEEP(SEC) Sleep((SEC) * 1000)
+#else
+# include <unistd.h>
+# define SLEEP(SEC) sleep((SEC))
+#endif
+
+#define CODE_SOH (0x01)
+#define CODE_EOT (0x04)
+#define CODE_ACK (0x06)
+#define CODE_NAK (0x15)
+#define CODE_CAN (0x18)
+#define CODE_EOF (0x1A)
+#define CODE_EOF (0x1A)
+#define XMODEM_DATA_BLKSIZ (128)
+#define XMODEM_SEND_BLKSIZ (3 + XMODEM_DATA_BLKSIZ + 1)
+
+#define TIMEOUT_SHORT_MS (10)
+#define TIMEOUT_LONG_MS (1000)
+
+#define NAK_WAIT_SEC (20)
+#define NAK_WAIT_TIMES ((NAK_WAIT_SEC * 1000) / TIMEOUT_SHORT_MS)
+
+/**
+ * @brief シリアルポートに残留するデータをフラッシュする。
+ * @details
+ * ターゲット側には、接続前に何らかの入力が行なわれている可能性がある。
+ * ホスト側には、ターゲット側からやってきたエコーバック文字列や
+ * プロンプトの表示などが残っているかもしれない。
+ * リターンコードを送ってターゲット側のコマンド解釈層に残っている
+ * データをフラッシュする。
+ *
+ * @param serial シリアルハンドラ。
+ *
+ * @return エラーコード。
+ */
+ErrorCode flush_serial(SERIAL *serial)
+{
+ unsigned char buf[64];
+
+ /*
+ * リターンコードをターゲットに送信する。
+ */
+ if (serial_write(serial, (unsigned char *)"\n", 1) != 0) {
+ return SerialWriteError;
+ }
+
+ /*
+ * リターンに対するエコーバックとプロンプトを飲み込む。
+ * もしかしたら、シリアルポートドライバが抱えている
+ * バッファリングされたデータも読み出されるかもしれない。
+ * 必ず受信するわけではないので、ここではエラーを見ない。
+ */
+ serial_read_with_timeout(serial, buf, sizeof(buf), TIMEOUT_SHORT_MS);
+
+ /*
+ * どんなものを受信したか知りたい場合、
+ * ここでbufを表示させてみれば良い。
+ */
+
+ return NoError;
+}
+
+/**
+ * @brief KOZOSブートローダをロード状態に遷移させる。
+ * @details
+ * KOZOSブートローダは、loadというコマンドによってロード状態に遷移する。
+ *
+ * @param serial シリアルハンドラ。
+ *
+ * @return エラーコード。
+ */
+ErrorCode setup_load_condition(SERIAL *serial)
+{
+ unsigned char buf[64];
+
+ /*
+ * loadコマンドを発行する。
+ */
+ if (serial_write(serial, (unsigned char *)"load\n", 5) != 0) {
+ return SerialWriteError;
+ }
+
+ /*
+ * エコーバックを飲み込む。
+ * 与えた受信要求長さを満たすわけでないのでエラーを見ない。
+ */
+ serial_read_with_timeout(serial, buf, sizeof(buf), TIMEOUT_SHORT_MS);
+
+ return NoError;
+}
+
+/**
+ * @brief ターゲットからのNAKコード受信を待つ。
+ * @details
+ * ターゲットからのNAKコードは数秒おきにやってくる事になっている。
+ * あまり長くやってこない時にはターゲット側が期待している状態に
+ * 遷移していないと判定してエラーとする。
+ *
+ * @param serial シリアルハンドラ。
+ *
+ * @return エラーコード。
+ */
+ErrorCode wait_target_nak(SERIAL *serial)
+{
+ ErrorCode retval = NoError;
+ int cnt = 0;
+
+ while (1) {
+ /*
+ * タイムアウトを設定して読み込みを行なう。
+ */
+ unsigned char c = 0x00;
+ serial_read_with_timeout(serial, &c, 1, TIMEOUT_SHORT_MS);
+
+ /*
+ * ユーザを不安にさせないための出力。
+ */
+ if ((cnt % (1000 / TIMEOUT_SHORT_MS)) == 0) {
+ fprintf(stderr, ".");
+ }
+
+ /*
+ * NAKを受信したら終了。
+ */
+ if (c == CODE_NAK) {
+ retval = NoError;
+ break;
+ }
+
+ /*
+ * タイムアウトとして扱うかどうかを判定する。
+ */
+ cnt++;
+ if (cnt > NAK_WAIT_TIMES) {
+ retval = TargetIllegalState;
+ break;
+ }
+ }
+ fprintf(stderr, "\n");
+
+ return retval;
+}
+
+/**
+ * @brief 与えられたバッファのチェックサムを計算する。
+ *
+ * @param buf バッファへのポインタ。
+ * @param siz バッファに格納されているデータバイト数。
+ *
+ * @return チェックサム計算結果。
+ */
+unsigned char CALC_CHECKSUM(const unsigned char *buf, const int siz)
+{
+ int i;
+ unsigned char cs = 0;
+ for (i = 0; i < siz; i++) {
+ cs += buf[i];
+ }
+ return cs;
+}
+
+/**
+ * @brief 転送を実行する。
+ *
+ * @param serial シリアルハンドラ。
+ * @param buf バッファへのポインタ。
+ * @param siz バッファに格納されているデータバイト数。
+ *
+ * @return ターゲットから受信した結果コード。
+ */
+unsigned char TRANSMIT_BLOCK(
+ SERIAL *serial, const unsigned char *buf, const int siz)
+{
+ unsigned char c = 0;
+ serial_write(serial, buf, siz);
+ serial_read_with_timeout(serial, &c, 1, TIMEOUT_LONG_MS);
+ return c;
+}
+
+/**
+ * @brief ファイルをターゲットに送信する。
+ *
+ * @param serial シリアルハンドラ。
+ * @param filename ファイル名。
+ *
+ * @return エラーコード。
+ */
+ErrorCode transmit_file(SERIAL *serial, const char *filename)
+{
+ ErrorCode retval = NoError;
+
+ /*
+ * ファイルをオープンする。
+ */
+ FILE *fp = fopen(filename, "rb");
+ if (fp == NULL) {
+ return FileOpenError;
+ }
+
+ /*
+ * ファイルの長さを取得する。
+ */
+ if (fseek(fp, 0L, SEEK_END) != 0) {
+ retval = FileSeekError;
+ goto out;
+ }
+ long file_size = ftell(fp);
+ int block_count = file_size / XMODEM_DATA_BLKSIZ;
+ int block_remainder = file_size % XMODEM_DATA_BLKSIZ;
+ if (fseek(fp, 0L, SEEK_SET) != 0) {
+ retval = FileSeekError;
+ goto out;
+ }
+ fprintf(stderr, "File(%s): %d blocks + %d bytes\n",
+ filename, block_count, block_remainder);
+
+ /*
+ * ブロック転送を開始する。
+ */
+ unsigned char block_number = 1;
+ {
+ int i;
+ for (i = 0; i < block_count; i++) {
+ unsigned char c;
+ unsigned char buf[XMODEM_SEND_BLKSIZ];
+ buf[0] = CODE_SOH;
+ buf[1] = block_number;
+ buf[2] = ~block_number;
+ if (fread(buf + 3, XMODEM_DATA_BLKSIZ, 1, fp) != 1) {
+ retval = FileReadError;
+ goto out;
+ }
+ buf[3 + XMODEM_DATA_BLKSIZ] =
+ CALC_CHECKSUM(&buf[3], XMODEM_DATA_BLKSIZ);
+ do {
+ c = TRANSMIT_BLOCK(serial, buf, sizeof(buf));
+ fprintf(stderr, "%c", (c == CODE_ACK) ? '.' : 'x');
+ } while (c == CODE_NAK);
+ if (c != CODE_ACK) {
+ retval = TargetIllegalResponse;
+ goto out;
+ }
+ block_number++;
+ }
+ }
+ if (block_remainder > 0) {
+ unsigned char c;
+ unsigned char buf[XMODEM_SEND_BLKSIZ];
+ buf[0] = CODE_SOH;
+ buf[1] = block_number;
+ buf[2] = ~block_number;
+ memset(buf + 3, CODE_EOF, XMODEM_DATA_BLKSIZ);
+ if (fread(buf + 3, block_remainder, 1, fp) != 1) {
+ retval = FileReadError;
+ goto out;
+ }
+ buf[3 + XMODEM_DATA_BLKSIZ] =
+ CALC_CHECKSUM(&buf[3], XMODEM_DATA_BLKSIZ);
+ do {
+ c = TRANSMIT_BLOCK(serial, buf, sizeof(buf));
+ fprintf(stderr, "%c", (c == CODE_ACK) ? '.' : 'x');
+ } while (c == CODE_NAK);
+ if (c != CODE_ACK) {
+ retval = TargetIllegalResponse;
+ goto out;
+ }
+ }
+
+ /*
+ * 終了コードを送信して結果コードを取得する。
+ */
+ {
+ unsigned char c = CODE_EOT;
+ serial_write(serial, &c, 1);
+ serial_read_with_timeout(serial, &c, 1, TIMEOUT_LONG_MS);
+ if (c != CODE_ACK) {
+ retval = TargetIllegalResponse;
+ goto out;
+ }
+ }
+
+out:
+ fprintf(stderr, "\n");
+ fclose(fp);
+ return retval;
+}
+
+/**
+ * @brief エラーメッセージを表示する。
+ *
+ * @param ec エラーコード。
+ */
+void ERROR_MESSAGE(ErrorCode ec)
+{
+ char *txt;
+ switch (ec) {
+ case NoError:
+ txt = "No error.";
+ break;
+ case SerialOpenError:
+ txt = "Serial open error.";
+ break;
+ case SerialWriteError:
+ txt = "Serial write error.";
+ break;
+ case TargetIllegalState:
+ txt = "Illegal target state found.";
+ break;
+ case TargetIllegalResponse:
+ txt = "Illegal target response found.";
+ break;
+ case FileOpenError:
+ txt = "File open error.";
+ break;
+ case FileSeekError:
+ txt = "File seek error.";
+ break;
+ case FileReadError:
+ txt = "File read error.";
+ break;
+ default:
+ txt = "Unknown error.";
+ break;
+ }
+ fprintf(stderr, "%s\n", txt);
+}
+
+/**
+ * @brief エントリポイント。
+ *
+ * @param argc 引数の数。
+ * @param argv 引数のポインタのポインタ。
+ *
+ * @return シェルに返す値。
+ */
+int main(int argc, char **argv)
+{
+ ErrorCode ec;
+
+ fprintf(stderr, "=================================================\n");
+ fprintf(stderr, " XMODEM for KOZOS H8/3069F (Version %d.%d.%d)\n",
+ VERSION_MAJOR,
+ VERSION_MINOR,
+ VERSION_RELEASE);
+ fprintf(stderr, " Copyright(C) 2012 Shinichiro Nakamura\n");
+ fprintf(stderr, "=================================================\n");
+
+ if (argc != 3) {
+ fprintf(stderr, "kz_xmodem [elf file] [interface]\n");
+ return 1;
+ }
+
+ /*
+ * シリアルをオープンする。
+ */
+ SERIAL *serial = serial_open(argv[2], SerialBaud9600);
+ if (serial == NULL) {
+ fprintf(stderr, "Serial open failed.\n");
+ return 2;
+ }
+
+ /*
+ * ホストとターゲットのシリアルポートに滞留しているデータを吐き出す。
+ */
+ fprintf(stderr, "Flushing serial port.\n");
+ ec = flush_serial(serial);
+ if (ec != NoError) {
+ goto failure;
+ }
+
+ /*
+ * バッファリングによってコマンドが行き違いになるのを防ぐ。
+ */
+ fprintf(stderr, "Wait.\n");
+ SLEEP(1);
+
+ /*
+ * KOZOSブートローダをload状態に遷移させる。
+ */
+ fprintf(stderr, "Setup load condition.\n");
+ ec = setup_load_condition(serial);
+ if (ec != NoError) {
+ goto failure;
+ }
+
+ /*
+ * ターゲットからのNAK着信を待つ。
+ */
+ fprintf(stderr, "Wait a NAK.\n");
+ ec = wait_target_nak(serial);
+ if (ec != NoError) {
+ goto failure;
+ }
+
+ /*
+ * ELFファイルをターゲットに転送する。
+ */
+ fprintf(stderr, "Transmit the target ELF file.\n");
+ ec = transmit_file(serial, argv[1]);
+ if (ec != NoError) {
+ goto failure;
+ }
+
+ /*
+ * ターゲットからやってくる最後のメッセージを待つ。
+ */
+ fprintf(stderr, "Wait a message from the target.\n");
+ SLEEP(1);
+
+ /*
+ * ターゲットからやってくる最後のメッセージを飲み込む。
+ */
+ flush_serial(serial);
+
+ /*
+ * シリアルポートを閉じる。
+ */
+ serial_close(serial);
+
+ /*
+ * 正常終了を示す文字列を出力して終了。
+ */
+ fprintf(stderr, "Complete.\n");
+ return (int)NoError;
+
+failure:
+ /*
+ * シリアルポートを閉じる。
+ */
+ serial_close(serial);
+
+ /*
+ * エラーメッセージを出力して終了。
+ */
+ fprintf(stderr, "Error: ");
+ ERROR_MESSAGE(ec);
+ return (int)ec;
+}
+
--- /dev/null
+/**
+ * @file kz_xmodem.h
+ * @author Shinichiro Nakamura
+ * @brief XMODEM for KOZOS.
+ */
+
+/*
+ * ===============================================================
+ * XMODEM for KOZOS
+ * Version 0.0.2
+ * ===============================================================
+ * Copyright (c) 2012 Shinichiro Nakamura
+ *
+ * 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 KZ_XMODEM_H
+#define KZ_XMODEM_H
+
+#define VERSION_MAJOR (0)
+#define VERSION_MINOR (0)
+#define VERSION_RELEASE (2)
+
+/**
+ * @brief エラーコード。
+ */
+typedef enum {
+ NoError = 0,
+ SerialOpenError,
+ SerialWriteError,
+ TargetIllegalState,
+ TargetIllegalResponse,
+ FileOpenError,
+ FileSeekError,
+ FileReadError,
+} ErrorCode;
+
+#endif
+
--- /dev/null
+\r
+Microsoft Visual Studio Solution File, Format Version 11.00\r
+# Visual C++ Express 2010\r
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "kz_xmodem", "kz_xmodem.vcxproj", "{23ED9AFD-1600-4C5C-84E3-05971CE08B90}"\r
+EndProject\r
+Global\r
+ GlobalSection(SolutionConfigurationPlatforms) = preSolution\r
+ Debug|Win32 = Debug|Win32\r
+ Release|Win32 = Release|Win32\r
+ EndGlobalSection\r
+ GlobalSection(ProjectConfigurationPlatforms) = postSolution\r
+ {23ED9AFD-1600-4C5C-84E3-05971CE08B90}.Debug|Win32.ActiveCfg = Debug|Win32\r
+ {23ED9AFD-1600-4C5C-84E3-05971CE08B90}.Debug|Win32.Build.0 = Debug|Win32\r
+ {23ED9AFD-1600-4C5C-84E3-05971CE08B90}.Release|Win32.ActiveCfg = Release|Win32\r
+ {23ED9AFD-1600-4C5C-84E3-05971CE08B90}.Release|Win32.Build.0 = Release|Win32\r
+ EndGlobalSection\r
+ GlobalSection(SolutionProperties) = preSolution\r
+ HideSolutionNode = FALSE\r
+ EndGlobalSection\r
+EndGlobal\r
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>\r
+<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">\r
+ <ItemGroup Label="ProjectConfigurations">\r
+ <ProjectConfiguration Include="Debug|Win32">\r
+ <Configuration>Debug</Configuration>\r
+ <Platform>Win32</Platform>\r
+ </ProjectConfiguration>\r
+ <ProjectConfiguration Include="Release|Win32">\r
+ <Configuration>Release</Configuration>\r
+ <Platform>Win32</Platform>\r
+ </ProjectConfiguration>\r
+ </ItemGroup>\r
+ <PropertyGroup Label="Globals">\r
+ <ProjectGuid>{23ED9AFD-1600-4C5C-84E3-05971CE08B90}</ProjectGuid>\r
+ <Keyword>Win32Proj</Keyword>\r
+ <RootNamespace>kz_xmodem</RootNamespace>\r
+ </PropertyGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">\r
+ <ConfigurationType>Application</ConfigurationType>\r
+ <UseDebugLibraries>true</UseDebugLibraries>\r
+ <CharacterSet>MultiByte</CharacterSet>\r
+ <WholeProgramOptimization>true</WholeProgramOptimization>\r
+ </PropertyGroup>\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">\r
+ <ConfigurationType>Application</ConfigurationType>\r
+ <UseDebugLibraries>false</UseDebugLibraries>\r
+ <WholeProgramOptimization>true</WholeProgramOptimization>\r
+ <CharacterSet>MultiByte</CharacterSet>\r
+ </PropertyGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />\r
+ <ImportGroup Label="ExtensionSettings">\r
+ </ImportGroup>\r
+ <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />\r
+ </ImportGroup>\r
+ <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />\r
+ </ImportGroup>\r
+ <PropertyGroup Label="UserMacros" />\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <LinkIncremental>true</LinkIncremental>\r
+ </PropertyGroup>\r
+ <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <LinkIncremental>false</LinkIncremental>\r
+ </PropertyGroup>\r
+ <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">\r
+ <ClCompile>\r
+ <PrecompiledHeader>\r
+ </PrecompiledHeader>\r
+ <WarningLevel>Level3</WarningLevel>\r
+ <Optimization>Disabled</Optimization>\r
+ <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>\r
+ <DisableSpecificWarnings>4996;4819</DisableSpecificWarnings>\r
+ <CompileAs>CompileAsCpp</CompileAs>\r
+ <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>\r
+ </ClCompile>\r
+ <Link>\r
+ <SubSystem>Console</SubSystem>\r
+ <GenerateDebugInformation>true</GenerateDebugInformation>\r
+ </Link>\r
+ </ItemDefinitionGroup>\r
+ <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">\r
+ <ClCompile>\r
+ <WarningLevel>Level3</WarningLevel>\r
+ <PrecompiledHeader>\r
+ </PrecompiledHeader>\r
+ <Optimization>MaxSpeed</Optimization>\r
+ <FunctionLevelLinking>true</FunctionLevelLinking>\r
+ <IntrinsicFunctions>true</IntrinsicFunctions>\r
+ <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>\r
+ <DisableSpecificWarnings>4996;4819</DisableSpecificWarnings>\r
+ <CompileAs>CompileAsCpp</CompileAs>\r
+ <RuntimeLibrary>MultiThreaded</RuntimeLibrary>\r
+ </ClCompile>\r
+ <Link>\r
+ <SubSystem>Console</SubSystem>\r
+ <GenerateDebugInformation>true</GenerateDebugInformation>\r
+ <EnableCOMDATFolding>true</EnableCOMDATFolding>\r
+ <OptimizeReferences>true</OptimizeReferences>\r
+ </Link>\r
+ </ItemDefinitionGroup>\r
+ <ItemGroup>\r
+ <ClCompile Include="kz_xmodem.c" />\r
+ <ClCompile Include="serial_windows.c" />\r
+ </ItemGroup>\r
+ <ItemGroup>\r
+ <ClInclude Include="kz_xmodem.h" />\r
+ <ClInclude Include="serial.h" />\r
+ </ItemGroup>\r
+ <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />\r
+ <ImportGroup Label="ExtensionTargets">\r
+ </ImportGroup>\r
+</Project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>\r
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">\r
+ <ItemGroup>\r
+ <Filter Include="ソース ファイル">\r
+ <UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>\r
+ <Extensions>cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx</Extensions>\r
+ </Filter>\r
+ <Filter Include="ヘッダー ファイル">\r
+ <UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>\r
+ <Extensions>h;hpp;hxx;hm;inl;inc;xsd</Extensions>\r
+ </Filter>\r
+ <Filter Include="リソース ファイル">\r
+ <UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>\r
+ <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>\r
+ </Filter>\r
+ </ItemGroup>\r
+ <ItemGroup>\r
+ <ClCompile Include="kz_xmodem.c">\r
+ <Filter>ソース ファイル</Filter>\r
+ </ClCompile>\r
+ <ClCompile Include="serial_windows.c">\r
+ <Filter>ソース ファイル</Filter>\r
+ </ClCompile>\r
+ </ItemGroup>\r
+ <ItemGroup>\r
+ <ClInclude Include="serial.h">\r
+ <Filter>ヘッダー ファイル</Filter>\r
+ </ClInclude>\r
+ <ClInclude Include="kz_xmodem.h">\r
+ <Filter>ヘッダー ファイル</Filter>\r
+ </ClInclude>\r
+ </ItemGroup>\r
+</Project>
\ No newline at end of file
--- /dev/null
+<?xml version="1.0" encoding="utf-8"?>\r
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">\r
+</Project>
\ No newline at end of file
--- /dev/null
+/**
+ * @file serial.h
+ * @author Shinichiro Nakamura
+ * @brief シリアルポートドライバのインターフェース定義。
+ */
+
+/*
+ * ===============================================================
+ * Serial interface library
+ * Version 0.0.4
+ * ===============================================================
+ * Copyright (c) 2010-2012 Shinichiro Nakamura
+ *
+ * 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 SERIAL_H
+#define SERIAL_H
+
+#include <stdio.h>
+
+typedef struct serial SERIAL;
+
+/**
+ * @brief ボーレート.
+ */
+enum SerialBaud {
+ SerialBaud2400,
+ SerialBaud4800,
+ SerialBaud9600,
+ SerialBaud19200,
+ SerialBaud38400
+};
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * シリアルポートをオープンする.
+ *
+ * @param devfile シリアルポートのデバイスファイル名.
+ * @param baud ボーレート.
+ *
+ * @retval !NULL ハンドラ。
+ * @retval NULL 失敗。
+ */
+SERIAL *serial_open(const char *devfile, const enum SerialBaud baud);
+
+/**
+ * シリアルポートをクローズする.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_close(SERIAL * s);
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read(SERIAL * s, unsigned char *buf, const size_t size);
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ * @param ms ミリ秒単位のタイムアウト時間.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read_with_timeout(
+ SERIAL * s, unsigned char *buf, const size_t size, const int ms);
+
+/**
+ * シリアルポートへ指定バイト数の書き込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 書き込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_write(SERIAL * s, const unsigned char *buf, const size_t size);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
--- /dev/null
+/**
+ * @file serial_linux.c
+ * @author Shinichiro Nakamura
+ * @brief シリアルポートドライバの実装。(Linuxプラットフォーム用)
+ */
+
+/*
+ * ===============================================================
+ * Serial interface library
+ * Version 0.0.4
+ * ===============================================================
+ * Copyright (c) 2010-2012 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdarg.h>
+#include <string.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <poll.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <termios.h>
+#include <limits.h>
+#include <pthread.h>
+#include "serial.h"
+
+#define MUTEX_INIT() pthread_mutex_init(&(s->mutex), NULL)
+#define MUTEX_LOCK() pthread_mutex_lock(&(s->mutex))
+#define MUTEX_UNLOCK() pthread_mutex_unlock(&(s->mutex))
+
+struct serial {
+ char devfile[BUFSIZ];
+ int fd;
+ struct termios termios_old;
+ struct termios termios_new;
+ pthread_mutex_t mutex;
+};
+
+/**
+ * シリアルポートをオープンする.
+ *
+ * @param devfile シリアルポートのデバイスファイル名.
+ * @param baud ボーレート.
+ *
+ * @retval !NULL ハンドラ。
+ * @retval NULL 失敗。
+ */
+SERIAL *serial_open(const char *devfile, const enum SerialBaud baud)
+{
+ int baudrate = 0;
+
+ /*
+ * シリアルデスクリプタの管理領域を確保する.
+ */
+ SERIAL *s = (SERIAL *) malloc(sizeof(SERIAL));
+ if (s == NULL) {
+ return NULL;
+ }
+
+ /*
+ * ミューテックスを初期化する.
+ */
+ MUTEX_INIT();
+
+ /*
+ * ポートを開く.
+ */
+ strcpy(s->devfile, devfile);
+ s->fd = open(devfile, O_RDWR | O_NOCTTY | O_NDELAY);
+ if (s->fd < 0) {
+ free(s);
+ return NULL;
+ }
+
+ /*
+ * ポート設定を退避する.
+ */
+ tcgetattr(s->fd, &(s->termios_old));
+
+ /*
+ * ポート設定を初期化する.
+ */
+ memset(&(s->termios_new), 0x00, sizeof(s->termios_new));
+
+ /*
+ * Bxxxxx : ボーレートの設定．cfsetispeed と cfsetospeed も使用できる
+ * CS8 : 8n1 (8 ビット，ノンパリティ，ストップビット 1)
+ * CLOCAL : ローカル接続，モデム制御なし
+ * CREAD : 受信文字(receiving characters)を有効にする
+ */
+ s->termios_new.c_cflag = CS8 | CLOCAL | CREAD;
+ switch (baud) {
+ case SerialBaud2400:
+ s->termios_new.c_cflag |= B2400;
+ baudrate = 2400;
+ break;
+ case SerialBaud4800:
+ s->termios_new.c_cflag |= B4800;
+ baudrate = 4800;
+ break;
+ case SerialBaud9600:
+ s->termios_new.c_cflag |= B9600;
+ baudrate = 9600;
+ break;
+ case SerialBaud19200:
+ s->termios_new.c_cflag |= B19200;
+ baudrate = 19200;
+ break;
+ case SerialBaud38400:
+ s->termios_new.c_cflag |= B38400;
+ baudrate = 38400;
+ break;
+ default:
+ s->termios_new.c_cflag |= B9600;
+ baudrate = 9600;
+ break;
+ }
+ cfsetispeed(&(s->termios_new), baudrate);
+ cfsetospeed(&(s->termios_new), baudrate);
+
+ /*
+ * IGNPAR : パリティエラーのデータは無視する
+ */
+ s->termios_new.c_iflag = IGNPAR;
+
+ /*
+ * Raw モードでの出力
+ */
+ s->termios_new.c_oflag = 0;
+
+ /*
+ * 入力モードをノンカノニカル、ノンエコーに設定する
+ */
+ s->termios_new.c_lflag = 0;
+
+ /*
+ * モデムラインをクリアし，ポートの設定を有効にする
+ */
+ tcflush(s->fd, TCIFLUSH);
+ tcsetpgrp(s->fd, getpgrp());
+ tcsetattr(s->fd, TCSANOW, &(s->termios_new));
+
+ return s;
+}
+
+/**
+ * シリアルポートをクローズする.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_close(SERIAL * s)
+{
+ /*
+ * ポート設定を元に戻す.
+ */
+ tcsetattr(s->fd, TCSANOW, &(s->termios_old));
+
+ /*
+ * ポートを閉じる.
+ */
+ close(s->fd);
+
+ /*
+ * シリアルデスクリプタの管理領域を破棄する.
+ */
+ free(s);
+
+ return 0;
+}
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read(SERIAL * s, unsigned char *buf, const size_t size)
+{
+ int e = 0;
+ int rcvcnt = 0;
+
+ MUTEX_LOCK();
+
+ /*
+ * 読み込みを実行する.
+ */
+ while (rcvcnt < size) {
+ int r = read(s->fd, buf + rcvcnt, size - rcvcnt);
+ if (r < 0) {
+ e = 1;
+ break;
+ }
+ rcvcnt += r;
+ }
+
+ MUTEX_UNLOCK();
+
+ return e;
+}
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ * @param ms ミリ秒単位のタイムアウト時間.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read_with_timeout(SERIAL * s,
+ unsigned char *buf, const size_t size, const int ms)
+{
+ int e = 0;
+ int i;
+
+ MUTEX_LOCK();
+
+ /*
+ * タイムアウトを設定して読み込みを実行する.
+ */
+ for (i = 0; i < (int) size; i++) {
+ struct pollfd fds;
+ fds.fd = s->fd;
+ fds.events = POLLIN;
+ poll(&fds, 1, ms);
+ if (fds.revents & POLLIN) {
+ /*
+ * 1バイトの読み込みを実行.
+ */
+ int r = read(s->fd, buf + i, 1);
+ if (r < 0) {
+ e = 1;
+ break;
+ }
+ } else {
+ /*
+ * タイムアウトが発生した.
+ */
+ e = 2;
+ break;
+ }
+ }
+
+ MUTEX_UNLOCK();
+
+ return e;
+}
+
+/**
+ * シリアルポートへ指定バイト数の書き込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 書き込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_write(SERIAL * s,
+ const unsigned char *buf, const size_t size)
+{
+ int e = 0;
+ int sndcnt = 0;
+
+ MUTEX_LOCK();
+
+ while (sndcnt < size) {
+ int r = write(s->fd, buf + sndcnt, size - sndcnt);
+ if (r < 0) {
+ e = 1;
+ break;
+ }
+ sndcnt += r;
+ }
+
+ MUTEX_UNLOCK();
+
+ return e;
+}
+
--- /dev/null
+/**
+ * @file serial_windows.c
+ * @author Shinichiro Nakamura
+ * @brief シリアルポートドライバの実装。(Windowsプラットフォーム用)
+ */
+
+/*
+ * ===============================================================
+ * Serial interface library
+ * Version 0.0.4
+ * ===============================================================
+ * Copyright (c) 2010-2012 Shinichiro Nakamura
+ *
+ * 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.
+ * ===============================================================
+ */
+
+#include <stdio.h>
+#include <Windows.h>
+#include <WinBase.h>
+#include "serial.h"
+
+struct serial {
+ char devfile[BUFSIZ];
+ HANDLE handle;
+};
+
+/**
+ * シリアルポートをオープンする.
+ *
+ * @param devfile シリアルポートのデバイスファイル名.
+ * @param baud ボーレート.
+ *
+ * @retval !NULL ハンドラ。
+ * @retval NULL 失敗。
+ */
+SERIAL *serial_open(const char *devfile, const enum SerialBaud baud)
+{
+ DCB param;
+ int baudrate = 0;
+
+ /*
+ * シリアルデスクリプタの管理領域を確保する.
+ */
+ SERIAL *s = (SERIAL *) malloc(sizeof(SERIAL));
+ if (s == NULL) {
+ return NULL;
+ }
+
+ /*
+ * ポート名を決定する.
+ */
+ if (strstr(devfile, "\\\\.\\") == NULL) {
+ strcpy(s->devfile, "\\\\.\\");
+ } else {
+ strcpy(s->devfile, "");
+ }
+ strcat(s->devfile, devfile);
+
+ /*
+ * ポートを開く.
+ */
+ s->handle = CreateFile(
+ s->devfile,
+ GENERIC_READ | GENERIC_WRITE,
+ 0,
+ NULL,
+ OPEN_EXISTING,
+ 0,
+ NULL);
+ if (s->handle == INVALID_HANDLE_VALUE) {
+ free(s);
+ return NULL;
+ }
+
+ /*
+ * ポートの設定を行う。
+ */
+ if (!GetCommState(s->handle, ¶m)) {
+ free(s);
+ return NULL;
+ }
+ switch (baud) {
+ case SerialBaud2400:
+ param.BaudRate = CBR_2400;
+ break;
+ case SerialBaud4800:
+ param.BaudRate = CBR_4800;
+ break;
+ case SerialBaud9600:
+ param.BaudRate = CBR_9600;
+ break;
+ case SerialBaud19200:
+ param.BaudRate = CBR_19200;
+ break;
+ case SerialBaud38400:
+ param.BaudRate = CBR_38400;
+ break;
+ default:
+ param.BaudRate = CBR_9600;
+ break;
+ }
+ param.ByteSize = 8;
+ param.StopBits = ONESTOPBIT;
+ param.Parity = NOPARITY;
+ if(!SetCommState(s->handle, ¶m)){
+ free(s);
+ return NULL;
+ }
+
+ /*
+ * バッファの内容を捨てる.
+ */
+ PurgeComm(s->handle, PURGE_RXCLEAR);
+ PurgeComm(s->handle, PURGE_TXCLEAR);
+ PurgeComm(s->handle, PURGE_RXABORT);
+ PurgeComm(s->handle, PURGE_TXABORT);
+
+ return s;
+}
+
+/**
+ * シリアルポートをクローズする.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_close(SERIAL * s)
+{
+
+ /*
+ * バッファの内容を捨てる.
+ */
+ PurgeComm(s->handle, PURGE_RXCLEAR);
+ PurgeComm(s->handle, PURGE_TXCLEAR);
+ PurgeComm(s->handle, PURGE_RXABORT);
+ PurgeComm(s->handle, PURGE_TXABORT);
+
+ /*
+ * ポートを閉じる.
+ */
+ CloseHandle(s->handle);
+
+ /*
+ * シリアルデスクリプタの管理領域を破棄する.
+ */
+ free(s);
+
+ return 0;
+}
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read(SERIAL * s, unsigned char *buf, const size_t size)
+{
+ int e = 0;
+ DWORD cnt;
+
+ /*
+ * 読み込みを実行する.
+ */
+ if(!ReadFile(s->handle, buf, size, &cnt, NULL)){
+ e = 1;
+ }
+
+ return e;
+}
+
+/**
+ * シリアルポートから指定バイト数の読み込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 読み込みバイト数.
+ * @param ms ミリ秒単位のタイムアウト時間.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_read_with_timeout(SERIAL * s,
+ unsigned char *buf, const size_t size, const int ms)
+{
+ int e = 0;
+ DWORD total = 0;
+
+ /*
+ * タイムアウトを設定して読み込みを実行する.
+ */
+ COMMTIMEOUTS cto;
+ cto.ReadIntervalTimeout = MAXDWORD;
+ cto.ReadTotalTimeoutConstant = ms;
+ cto.ReadTotalTimeoutMultiplier = MAXDWORD;
+ if(SetCommTimeouts(s->handle, &cto)){
+ /*
+ * 読み込みを実行する.
+ */
+ while (total < size) {
+ DWORD cnt = 0;
+ ReadFile(s->handle, buf + total, 1, &cnt, NULL);
+ if (cnt != 1) {
+ e = 2;
+ break;
+ }
+ total += cnt;
+ }
+ } else {
+ /*
+ * タイムアウトの設定に失敗した。
+ */
+ e = 1;
+ }
+
+ return e;
+}
+
+/**
+ * シリアルポートへ指定バイト数の書き込みを実行する.
+ *
+ * @param s シリアルデスクリプタへのポインタ.
+ * @param buf バッファへのポインタ.
+ * @param size 書き込みバイト数.
+ *
+ * @return 成功したら0を返す.
+ */
+int serial_write(SERIAL * s,
+ const unsigned char *buf, const size_t size)
+{
+ int e = 0;
+ DWORD cnt;
+
+ /*
+ * 書き込みを実行する.
+ */
+ if(!WriteFile(s->handle, buf, size, &cnt, NULL)){
+ e = 1;
+ }
+
+ return e;
+}
+
OSDN Git Service
