# API reference

The reference below is generated directly from the header doc-comments with
Doxygen and Breathe. For a narrative overview of what each header is for, see
{doc}`libraries`.

## Primitives

### bitfield.h

```{doxygenfile} upcie/bitfield.h
```

### barriers.h

```{doxygenfile} upcie/barriers.h
```

### mmio.h

```{doxygenfile} upcie/mmio.h
```

## PCI and VFIO

### pci.h

```{doxygenfile} upcie/pci.h
```

### vfioctl.h

```{doxygenfile} upcie/vfioctl.h
```

## Host memory

### hostmem_hugepage.h

```{doxygenfile} upcie/hostmem_hugepage.h
```

### hostmem_heap.h

```{doxygenfile} upcie/hostmem_heap.h
```

### hostmem_dma.h

```{doxygenfile} upcie/hostmem_dma.h
```

## dma-buf

### dmabuf.h

```{doxygenfile} upcie/dmabuf.h
```

## NVMe

### nvme_controller.h

```{doxygenfile} upcie/nvme/nvme_controller.h
```

### nvme_qpair.h

```{doxygenfile} upcie/nvme/nvme_qpair.h
```

### nvme_command.h

```{doxygenfile} upcie/nvme/nvme_command.h
```

### nvme_request.h

```{doxygenfile} upcie/nvme/nvme_request.h
```