| HighPoint Linux Team | ede1e6f | 2006-05-16 14:38:09 +0800 | [diff] [blame] | 1 | HIGHPOINT ROCKETRAID 3xxx RAID DRIVER (hptiop) |
| 2 | |
| 3 | Controller Register Map |
| 4 | ------------------------- |
| 5 | |
| 6 | The controller IOP is accessed via PCI BAR0. |
| 7 | |
| 8 | BAR0 offset Register |
| 9 | 0x10 Inbound Message Register 0 |
| 10 | 0x14 Inbound Message Register 1 |
| 11 | 0x18 Outbound Message Register 0 |
| 12 | 0x1C Outbound Message Register 1 |
| 13 | 0x20 Inbound Doorbell Register |
| 14 | 0x24 Inbound Interrupt Status Register |
| 15 | 0x28 Inbound Interrupt Mask Register |
| 16 | 0x30 Outbound Interrupt Status Register |
| 17 | 0x34 Outbound Interrupt Mask Register |
| 18 | 0x40 Inbound Queue Port |
| 19 | 0x44 Outbound Queue Port |
| 20 | |
| 21 | |
| 22 | I/O Request Workflow |
| 23 | ---------------------- |
| 24 | |
| 25 | All queued requests are handled via inbound/outbound queue port. |
| 26 | A request packet can be allocated in either IOP or host memory. |
| 27 | |
| 28 | To send a request to the controller: |
| 29 | |
| 30 | - Get a free request packet by reading the inbound queue port or |
| 31 | allocate a free request in host DMA coherent memory. |
| 32 | |
| 33 | The value returned from the inbound queue port is an offset |
| 34 | relative to the IOP BAR0. |
| 35 | |
| 36 | Requests allocated in host memory must be aligned on 32-bytes boundary. |
| 37 | |
| 38 | - Fill the packet. |
| 39 | |
| 40 | - Post the packet to IOP by writing it to inbound queue. For requests |
| 41 | allocated in IOP memory, write the offset to inbound queue port. For |
| 42 | requests allocated in host memory, write (0x80000000|(bus_addr>>5)) |
| 43 | to the inbound queue port. |
| 44 | |
| 45 | - The IOP process the request. When the request is completed, it |
| 46 | will be put into outbound queue. An outbound interrupt will be |
| 47 | generated. |
| 48 | |
| 49 | For requests allocated in IOP memory, the request offset is posted to |
| 50 | outbound queue. |
| 51 | |
| 52 | For requests allocated in host memory, (0x80000000|(bus_addr>>5)) |
| 53 | is posted to the outbound queue. If IOP_REQUEST_FLAG_OUTPUT_CONTEXT |
| 54 | flag is set in the request, the low 32-bit context value will be |
| 55 | posted instead. |
| 56 | |
| 57 | - The host read the outbound queue and complete the request. |
| 58 | |
| 59 | For requests allocated in IOP memory, the host driver free the request |
| 60 | by writing it to the outbound queue. |
| 61 | |
| 62 | Non-queued requests (reset/flush etc) can be sent via inbound message |
| 63 | register 0. An outbound message with the same value indicates the completion |
| 64 | of an inbound message. |
| 65 | |
| 66 | |
| 67 | User-level Interface |
| 68 | --------------------- |
| 69 | |
| 70 | The driver exposes following sysfs attributes: |
| 71 | |
| 72 | NAME R/W Description |
| 73 | driver-version R driver version string |
| 74 | firmware-version R firmware version string |
| 75 | |
| 76 | The driver registers char device "hptiop" to communicate with HighPoint RAID |
| 77 | management software. Its ioctl routine acts as a general binary interface |
| 78 | between the IOP firmware and HighPoint RAID management software. New management |
| 79 | functions can be implemented in application/firmware without modification |
| 80 | in driver code. |
| 81 | |
| 82 | |
| 83 | ----------------------------------------------------------------------------- |
| 84 | Copyright (C) 2006 HighPoint Technologies, Inc. All Rights Reserved. |
| 85 | |
| 86 | This file is distributed in the hope that it will be useful, |
| 87 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 88 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 89 | GNU General Public License for more details. |
| 90 | |
| 91 | linux@highpoint-tech.com |
| 92 | http://www.highpoint-tech.com |