From c78228082b4e5b845a9c5553ab9e52766b468ab9 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 8 Dec 2014 10:37:17 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7560 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/dox/hal_channels.dox | 24 ++++++++++ os/hal/dox/hal_ioblock.dox | 104 ++++++++++++++++++++++++++++++++++++++++++++ os/hal/dox/io_block.dox | 104 -------------------------------------------- os/hal/dox/io_channel.dox | 24 ---------- 4 files changed, 128 insertions(+), 128 deletions(-) create mode 100644 os/hal/dox/hal_channels.dox create mode 100644 os/hal/dox/hal_ioblock.dox delete mode 100644 os/hal/dox/io_block.dox delete mode 100644 os/hal/dox/io_channel.dox (limited to 'os') diff --git a/os/hal/dox/hal_channels.dox b/os/hal/dox/hal_channels.dox new file mode 100644 index 000000000..ae966c67e --- /dev/null +++ b/os/hal/dox/hal_channels.dox @@ -0,0 +1,24 @@ +/* + ChibiOS - Copyright (C) 2006,2007,2008,2009,2010, + 2011,2012,2013,2014 Giovanni Di Sirio. + + This file is part of ChibiOS/HAL + + ChibiOS/HAL is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + ChibiOS/RT is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +/** + * @defgroup IO_CHANNEL Abstract I/O Channel + * @ingroup HAL_INTERFACES + */ diff --git a/os/hal/dox/hal_ioblock.dox b/os/hal/dox/hal_ioblock.dox new file mode 100644 index 000000000..8adf8180e --- /dev/null +++ b/os/hal/dox/hal_ioblock.dox @@ -0,0 +1,104 @@ +/* + ChibiOS - Copyright (C) 2006,2007,2008,2009,2010, + 2011,2012,2013,2014 Giovanni Di Sirio. + + This file is part of ChibiOS/HAL + + ChibiOS/HAL is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + ChibiOS/RT is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +*/ + +/** + * @defgroup IO_BLOCK Abstract I/O Block Device + * @ingroup HAL_INTERFACES + * + * @section io_block_1 Driver State Machine + * The drivers implementing this interface shall implement the following + * state machine internally. Not all the driver functionalities can be used + * in any moment, any transition not explicitly shown in the following + * diagram has to be considered an error and shall be captured by an + * assertion (if enabled). + * @if LATEX_PDF + * @dot + digraph example { + size="5, 7"; + rankdir="LR"; + + node [shape=circle, fontname=Sans, fontsize=8, fixedsize="true", width="0.9", height="0.9"]; + edge [fontname=Sans, fontsize=8]; + + stop [label="BLK_STOP\nLow Power"]; + uninit [label="BLK_UNINIT", style="bold"]; + active [label="BLK_ACTIVE\nClock Enabled"]; + connecting [label="BLK_CONN.ING\nConnecting"]; + disconnecting [label="BLK_DISC.ING\nDisconnecting"]; + ready [label="BLK_READY\nCard Ready"]; + reading [label="BLK_READING\nReading"]; + writing [label="BLK_WRITING\nWriting"]; + + uninit -> stop [label=" blkInit()", constraint=false]; + stop -> stop [label="\nblkStop()"]; + stop -> active [label="\nblkStart()"]; + active -> stop [label="\nblkStop()"]; + active -> active [label="\nblkStart()\nblkDisconnect()"]; + active -> connecting [label="\nblkConnect()"]; + connecting -> ready [label="\nconnection\nsuccessful"]; + connecting -> ready [label="\nblkConnect()", dir="back"]; + connecting -> active [label="\nconnection\nfailed"]; + disconnecting -> ready [label="\nblkDisconnect()", dir="back"]; + active -> disconnecting [label="\ndisconnection\nfinished", dir="back"]; + ready -> reading [label="\nblkRead()"]; + reading -> ready [label="\nread finished\nread error"]; + ready -> writing [label="\nblkWrite()"]; + writing -> ready [label="\nwrite finished\nwrite error"]; + } + * @enddot + * @else + * @dot + digraph example { + rankdir="LR"; + + node [shape=circle, fontname=Sans, fontsize=8, fixedsize="true", width="0.9", height="0.9"]; + edge [fontname=Sans, fontsize=8]; + + stop [label="BLK_STOP\nLow Power"]; + uninit [label="BLK_UNINIT", style="bold"]; + active [label="BLK_ACTIVE\nClock Enabled"]; + connecting [label="BLK_CONN.ING\nConnecting"]; + disconnecting [label="BLK_DISC.ING\nDisconnecting"]; + ready [label="BLK_READY\nCard Ready"]; + reading [label="BLK_READING\nReading"]; + writing [label="BLK_WRITING\nWriting"]; + syncing [label="BLK_SYNCING\nSynchronizing"]; + + uninit -> stop [label=" blkInit()", constraint=false]; + stop -> stop [label="\nblkStop()"]; + stop -> active [label="\nblkStart()"]; + active -> stop [label="\nblkStop()"]; + active -> active [label="\nblkStart()\nblkDisconnect()"]; + active -> connecting [label="\nblkConnect()"]; + connecting -> ready [label="\nconnection\nsuccessful"]; + connecting -> ready [label="\nblkConnect()", dir="back"]; + connecting -> active [label="\nconnection\nfailed"]; + disconnecting -> ready [label="\nblkDisconnect()", dir="back"]; + active -> disconnecting [label="\ndisconnection\nfinished", dir="back"]; + ready -> reading [label="\nblkRead()"]; + reading -> ready [label="\nread finished\nread error"]; + ready -> writing [label="\nblkWrite()"]; + writing -> ready [label="\nwrite finished\nwrite error"]; + ready -> syncing [label="\nblkSync()"]; + syncing -> ready [label="\nsynchronization finished"]; + } + * @enddot + * @endif + */ diff --git a/os/hal/dox/io_block.dox b/os/hal/dox/io_block.dox deleted file mode 100644 index 8adf8180e..000000000 --- a/os/hal/dox/io_block.dox +++ /dev/null @@ -1,104 +0,0 @@ -/* - ChibiOS - Copyright (C) 2006,2007,2008,2009,2010, - 2011,2012,2013,2014 Giovanni Di Sirio. - - This file is part of ChibiOS/HAL - - ChibiOS/HAL is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/RT is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @defgroup IO_BLOCK Abstract I/O Block Device - * @ingroup HAL_INTERFACES - * - * @section io_block_1 Driver State Machine - * The drivers implementing this interface shall implement the following - * state machine internally. Not all the driver functionalities can be used - * in any moment, any transition not explicitly shown in the following - * diagram has to be considered an error and shall be captured by an - * assertion (if enabled). - * @if LATEX_PDF - * @dot - digraph example { - size="5, 7"; - rankdir="LR"; - - node [shape=circle, fontname=Sans, fontsize=8, fixedsize="true", width="0.9", height="0.9"]; - edge [fontname=Sans, fontsize=8]; - - stop [label="BLK_STOP\nLow Power"]; - uninit [label="BLK_UNINIT", style="bold"]; - active [label="BLK_ACTIVE\nClock Enabled"]; - connecting [label="BLK_CONN.ING\nConnecting"]; - disconnecting [label="BLK_DISC.ING\nDisconnecting"]; - ready [label="BLK_READY\nCard Ready"]; - reading [label="BLK_READING\nReading"]; - writing [label="BLK_WRITING\nWriting"]; - - uninit -> stop [label=" blkInit()", constraint=false]; - stop -> stop [label="\nblkStop()"]; - stop -> active [label="\nblkStart()"]; - active -> stop [label="\nblkStop()"]; - active -> active [label="\nblkStart()\nblkDisconnect()"]; - active -> connecting [label="\nblkConnect()"]; - connecting -> ready [label="\nconnection\nsuccessful"]; - connecting -> ready [label="\nblkConnect()", dir="back"]; - connecting -> active [label="\nconnection\nfailed"]; - disconnecting -> ready [label="\nblkDisconnect()", dir="back"]; - active -> disconnecting [label="\ndisconnection\nfinished", dir="back"]; - ready -> reading [label="\nblkRead()"]; - reading -> ready [label="\nread finished\nread error"]; - ready -> writing [label="\nblkWrite()"]; - writing -> ready [label="\nwrite finished\nwrite error"]; - } - * @enddot - * @else - * @dot - digraph example { - rankdir="LR"; - - node [shape=circle, fontname=Sans, fontsize=8, fixedsize="true", width="0.9", height="0.9"]; - edge [fontname=Sans, fontsize=8]; - - stop [label="BLK_STOP\nLow Power"]; - uninit [label="BLK_UNINIT", style="bold"]; - active [label="BLK_ACTIVE\nClock Enabled"]; - connecting [label="BLK_CONN.ING\nConnecting"]; - disconnecting [label="BLK_DISC.ING\nDisconnecting"]; - ready [label="BLK_READY\nCard Ready"]; - reading [label="BLK_READING\nReading"]; - writing [label="BLK_WRITING\nWriting"]; - syncing [label="BLK_SYNCING\nSynchronizing"]; - - uninit -> stop [label=" blkInit()", constraint=false]; - stop -> stop [label="\nblkStop()"]; - stop -> active [label="\nblkStart()"]; - active -> stop [label="\nblkStop()"]; - active -> active [label="\nblkStart()\nblkDisconnect()"]; - active -> connecting [label="\nblkConnect()"]; - connecting -> ready [label="\nconnection\nsuccessful"]; - connecting -> ready [label="\nblkConnect()", dir="back"]; - connecting -> active [label="\nconnection\nfailed"]; - disconnecting -> ready [label="\nblkDisconnect()", dir="back"]; - active -> disconnecting [label="\ndisconnection\nfinished", dir="back"]; - ready -> reading [label="\nblkRead()"]; - reading -> ready [label="\nread finished\nread error"]; - ready -> writing [label="\nblkWrite()"]; - writing -> ready [label="\nwrite finished\nwrite error"]; - ready -> syncing [label="\nblkSync()"]; - syncing -> ready [label="\nsynchronization finished"]; - } - * @enddot - * @endif - */ diff --git a/os/hal/dox/io_channel.dox b/os/hal/dox/io_channel.dox deleted file mode 100644 index ae966c67e..000000000 --- a/os/hal/dox/io_channel.dox +++ /dev/null @@ -1,24 +0,0 @@ -/* - ChibiOS - Copyright (C) 2006,2007,2008,2009,2010, - 2011,2012,2013,2014 Giovanni Di Sirio. - - This file is part of ChibiOS/HAL - - ChibiOS/HAL is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - ChibiOS/RT is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . -*/ - -/** - * @defgroup IO_CHANNEL Abstract I/O Channel - * @ingroup HAL_INTERFACES - */ -- cgit v1.2.3