2
0
mirror of https://git.missingno.dev/kolibrios-nvme-driver/ synced 2024-12-22 22:08:47 +01:00
kolibrios-nvme-driver/drivers/nvme/nvme.asm

309 lines
7.7 KiB
NASM
Raw Normal View History

2024-04-17 21:44:10 +02:00
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; ;;
;; Copyright (C) KolibriOS team 2004-2024. All rights reserved. ;;
;; Distributed under terms of the GNU General Public License ;;
;; ;;
;; GNU GENERAL PUBLIC LICENSE ;;
;; Version 2, June 1991 ;;
;; ;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2024-03-28 23:43:18 +01:00
format PE DLL native
entry START
API_VERSION equ 0 ;debug
SRV_GETVERSION equ 0
2024-03-30 04:42:01 +01:00
__DEBUG__ = 1
__DEBUG_LEVEL__ = 1
DRIVER_VERSION = 1
DBG_INFO = 1
2024-03-28 23:43:18 +01:00
section ".flat" code readable writable executable
include "../proc32.inc"
include "../struct.inc"
include "../macros.inc"
2024-03-30 04:42:01 +01:00
include "../fdo.inc"
2024-03-28 23:43:18 +01:00
include "../pci.inc"
2024-03-30 04:42:01 +01:00
include "../peimport.inc"
2024-03-31 21:43:38 +02:00
include "nvme.inc"
2024-04-21 02:29:06 +02:00
include "macros.inc"
2024-03-28 23:43:18 +01:00
proc START c, reason:dword
2024-03-28 23:43:18 +01:00
cmp [reason], DRV_ENTRY
jne .err
2024-03-28 23:43:18 +01:00
.entry:
DEBUGF DBG_INFO, "Detecting NVMe hardware...\n"
call detect_nvme
2024-04-28 02:11:57 +02:00
test eax, eax
jz .err
mov eax, dword [p_nvme_devices]
test eax, eax
2024-04-28 02:11:57 +02:00
jz .err
2024-04-28 19:50:40 +02:00
xor ecx, ecx
mov ebx, eax
2024-04-28 19:50:40 +02:00
.loop:
2024-04-29 03:06:13 +02:00
stdcall device_is_compat, dword [ebx + ecx * sizeof.pcidev]
2024-04-28 19:50:40 +02:00
test eax, eax
jz @f
2024-04-29 03:06:13 +02:00
stdcall nvme_init, dword [ebx + ecx * sizeof.pcidev]
2024-03-28 23:43:18 +01:00
2024-04-28 19:50:40 +02:00
@@:
inc ecx
cmp ecx, dword [pcidevs_len]
jne .loop
2024-03-28 23:43:18 +01:00
invoke RegService, my_service, service_proc
ret
.err:
call nvme_cleanup
2024-03-28 23:43:18 +01:00
xor eax, eax
ret
2024-03-28 23:43:18 +01:00
endp
proc service_proc stdcall, ioctl:dword
mov ebx, [ioctl]
mov eax, [ebx+IOCTL.io_code]
cmp eax, SRV_GETVERSION
jne @F
mov eax, [ebx+IOCTL.output]
cmp [ebx+IOCTL.out_size], 4
jne @F
2024-03-28 23:43:18 +01:00
mov dword [eax], API_VERSION
xor eax, eax
ret
@@:
or eax, -1
ret
2024-03-28 23:43:18 +01:00
endp
2024-03-31 21:43:38 +02:00
proc memset stdcall, p_data:dword, val:byte, sz:dword
2024-04-29 03:06:13 +02:00
push ebx ecx edx
2024-04-28 02:11:57 +02:00
mov edx, [sz]
2024-04-29 03:06:13 +02:00
mov bl, [val]
xor ecx, ecx
2024-03-31 21:43:38 +02:00
@@:
2024-04-29 03:06:13 +02:00
mov byte [p_data + ecx], bl
inc ecx
2024-04-28 02:11:57 +02:00
cmp ecx, edx
jne @b
2024-04-29 03:06:13 +02:00
pop edx ecx ebx
ret
2024-03-31 21:43:38 +02:00
endp
; Submit a Command in the Admin Submission Queue
proc submit_asq stdcall, p_sq:dword
xor eax, eax
ret
2024-03-31 21:43:38 +02:00
endp
proc nvme_identify stdcall, nsid:dword, dptr:dword, cns:byte
sub esp, sizeof.SQ_ENTRY
stdcall memset, esp, 0, sizeof.SQ_ENTRY
mov eax, dword [nsid]
mov dword [esp + SQ_ENTRY.nsid], eax
mov eax, dword [dptr]
mov dword [esp + SQ_ENTRY.dptr], eax
mov dword [esp + SQ_ENTRY.cdw0], ADM_CMD_IDENTIFY ; TODO: setting CID to 0 for now but later on keep a unique list of identifiers
2024-04-29 03:06:13 +02:00
mov al, byte [cns]
mov byte [esp + SQ_ENTRY.cdw10], al
stdcall submit_asq, esp
add esp, sizeof.SQ_ENTRY
xor eax, eax
ret
2024-03-30 04:42:01 +01:00
endp
proc detect_nvme
2024-03-28 23:43:18 +01:00
invoke GetPCIList
mov edx, eax
2024-03-28 23:43:18 +01:00
.check_dev:
mov ebx, dword [eax + PCIDEV.class]
and ebx, 0x00ffff00 ; retrieve class/subclass code only
cmp ebx, 0x00010800 ; Mass Storage Controller - Non-Volatile Memory Controller
je .found_dev
2024-03-28 23:43:18 +01:00
.next_dev:
mov eax, dword [eax + PCIDEV.fd]
2024-03-28 23:43:18 +01:00
cmp eax, edx
jne .check_dev
2024-04-28 02:11:57 +02:00
jmp .exit_success
.found_dev:
2024-04-28 02:11:57 +02:00
push edx eax
2024-04-29 03:06:13 +02:00
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): Detected NVMe device...\n", byte [eax + PCIDEV.bus], byte [eax + PCIDEV.devfn]
2024-04-28 02:11:57 +02:00
cmp dword [pcidevs_len], TOTAL_PCIDEVS
jne @f
2024-04-28 02:11:57 +02:00
pop eax edx
jmp .exit_success
@@:
2024-04-28 02:11:57 +02:00
inc dword [pcidevs_len]
mov ebx, dword [p_nvme_devices]
test ebx, ebx
jnz @f
2024-04-28 02:11:57 +02:00
invoke KernelAlloc, TOTAL_PCIDEVS_MALLOC_SZ
test eax, eax
2024-04-28 02:11:57 +02:00
jz .err_no_mem
mov dword [p_nvme_devices], eax
@@:
2024-04-28 02:11:57 +02:00
mov ebx, dword [p_nvme_devices]
mov ecx, dword [pcidevs_len]
2024-04-28 02:11:57 +02:00
dec ecx
pop eax
2024-04-28 02:11:57 +02:00
movzx edx, byte [eax + PCIDEV.bus]
mov byte [ebx + ecx * sizeof.pcidev + pcidev.bus], dl
movzx edx, byte [eax + PCIDEV.devfn]
mov byte [ebx + ecx * sizeof.pcidev + pcidev.devfn], dl
pop edx
jmp .next_dev
.err_no_mem:
pop eax edx
xor eax, eax
ret
2024-04-28 02:11:57 +02:00
.exit_success:
xor eax, eax
inc eax
ret
endp
2024-04-29 03:06:13 +02:00
proc device_is_compat stdcall, pci:dword
2024-04-29 03:06:13 +02:00
push ebx
invoke PciRead32, dword [pci + pcidev.bus], dword [pci + pcidev.devfn], PCI_header00.base_addr_0
and eax, 0xfffffff0
test eax, eax
2024-04-29 03:06:13 +02:00
jz .failure
invoke MapIoMem, eax, sizeof.NVME_REG_MAP, PG_SW+PG_NOCACHE
test eax, eax
2024-04-29 03:06:13 +02:00
jz .failure
mov dword [pci + pcidev.mmio_ptr], eax
mov ebx, dword [eax + NVME_REG_MAP.VS]
if __DEBUG__
push ecx
mov ecx, ebx
shr ecx, 16
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): NVMe controller version: %u.%u.%u\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn], ecx, bh, bl
pop ecx
end if
cmp ebx, NVM_SUPPORTED_CONTROLLER_VERSION
jne .unsupported
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): NVMe controller version is supported\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn]
2024-04-28 02:11:57 +02:00
xor eax, eax
inc eax
2024-04-29 03:06:13 +02:00
pop ebx
2024-04-28 02:11:57 +02:00
ret
2024-04-29 03:06:13 +02:00
.unsupported:
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): unsupported controller version\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn]
.failure:
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): something went wrong checking NVMe device compatibility\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn]
xor eax, eax
2024-04-29 03:06:13 +02:00
pop ebx
ret
endp
; nvme_init: Initializes the NVMe controller
2024-04-29 03:06:13 +02:00
proc nvme_init stdcall, pci:dword
2024-04-29 03:06:13 +02:00
push ebx ecx
mov eax, dword [pci + pcidev.mmio_ptr]
mov bx, word [eax + NVME_REG_MAP.CAP]
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): NVMe maximum queue entries supported: %u\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn], bx
test ebx, CAP_CQR
jz .cqr_not_req
2024-04-29 03:06:13 +02:00
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): NVMe contiguous queues required\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn]
2024-03-28 23:43:18 +01:00
2024-04-02 01:47:14 +02:00
.cqr_not_req:
mov ebx, dword [eax + NVME_REG_MAP.CAP + 4]
mov ecx, ebx
test ebx, CAP_CSS_NVM_CMDSET
jz .exit_fail
2024-04-29 03:06:13 +02:00
if __DEBUG__
and ebx, CAP_MPSMIN
and ecx, CAP_MPSMAX
shr ebx, 16
shr ecx, 16
2024-04-29 03:06:13 +02:00
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): NVMe memory page size minimum: %u\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn], ebx
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): NVMe memory page size maximum: %u\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn], ecx
mov ebx, dword [eax + NVME_REG_MAP.CC]
mov ecx, ebx
and ebx, CC_IOSQES
and ecx, CC_IOCQES
shl ebx, 16
shl ecx, 16
; TODO: Change entry sizes to their appropriate values
2024-04-29 03:06:13 +02:00
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): NVMe I/O submission queue entry size: %u\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn], ebx
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): NVMe I/O completion queue entry size: %u\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn], ecx
end if
2024-03-28 23:43:18 +01:00
xor eax, eax
inc eax
2024-04-29 03:06:13 +02:00
pop ecx ebx
2024-03-28 23:43:18 +01:00
ret
2024-03-31 21:43:38 +02:00
2024-04-02 01:47:14 +02:00
.exit_fail:
2024-04-29 03:06:13 +02:00
PDEBUGF DBG_INFO, "PCI(%u.%u.%u): failed to initialize NVMe controller\n", byte [pci + pcidev.bus], byte [pci + pcidev.devfn]
xor eax, eax
2024-04-29 03:06:13 +02:00
pop ecx ebx
2024-03-31 21:43:38 +02:00
ret
2024-03-31 21:43:38 +02:00
endp
proc nvme_cleanup
DEBUGF DBG_INFO, "(NVMe): Cleaning up...\n"
2024-04-29 03:06:13 +02:00
push ecx
xor ecx, ecx
mov eax, dword [p_nvme_devices]
test eax, eax
jnz .loop
ret
2024-04-29 03:06:13 +02:00
.loop:
;invoke KernelFree, dword [p_nvme_devices + ecx * sizeof.pcidev + pcidev.ident_ptr]
inc ecx
cmp ecx, dword [pcidevs_len]
jne .loop
invoke KernelFree, dword [p_nvme_devices]
pop ecx
ret
2024-03-28 23:43:18 +01:00
2024-04-29 03:06:13 +02:00
endp
2024-03-28 23:43:18 +01:00
;all initialized data place here
align 4
p_nvme_devices dd 0
pcidevs_len dd 0
2024-04-17 22:04:49 +02:00
my_service db "NVMe",0 ;max 16 chars include zero
include_debug_strings
2024-03-28 23:43:18 +01:00
align 4
data fixups
end data