Применение динамческого мапирования DMA для драйверов обычных устройств


Содержание

Обзор
Часть I - pci_ и dma_ Equivalent API
Часть Ia - Использование больших когерентных буферов DMA
Часть Ib - Использование небольшого dma- когерентного буфера
Часть Ic - Ограничения адресации DMA
Часть Id - Потоковое мапирование DMA
Часть II - Использование dma_ для продвинутых программистов
Часть III - Отладка драйвера, используя DMA-API

Обзор

Этот документ описывает API ядра для работы с DMA. Для облегчения понимания терминологоии и выражений pci_ equivalents (и примеров) смотри Documentation/PCI/PCI-DMA-mapping.txt

Данное API можно разбить на две части. Первая часть описывает само API и pci_API. Вторая часть описывает расширения API для поддержки механизма управлением непоследовательными участками памяти. Пока Вы точно не убедитесь в том. что ваш драйвер должен поддерживать непоследовательные платформы (это нормально для традиционных платформ), Вы должны использовать только API, описанное в первой части. .

Часть I - pci_ и dma_ Equivalent API

Для использования pci_ API, Вы должны добавить #include <linux/pci.h> Для использования dma_ API, Вы должны добавить #include <linux/dma-mapping.h>

Часть Ia - Использование больших когерентных буферов DMA

void *
dma_alloc_coherent(struct device *dev, size_t size,
			     dma_addr_t *dma_handle, gfp_t flag)
void *
pci_alloc_consistent(struct pci_dev *dev, size_t size,
			     dma_addr_t *dma_handle)

Непрерывная память - это такая память, для которой записанные процессом или устройством данные могут быть немедленно прочитаны другим процессом или устройством, и при этом не надо беспокоиться об эффектах кеширования. (Однако возможно, что вам понадобиться проверить, что закончилась операция записи в буфер, перед тем, как разрешить устройству чтение всего буфера)

Эта подпрограмма выделяет регион размером size байт непрерывной памяти. Она возвращает указатель dma_handle, который можно преобразовать к указателю на целое, которое имеет размерность шины и используется в качестве базового адреса региона.

Возвращает указатель на выделенный регион (в виртуальном адресном пространстве процесса) или NULL, если выделение памяти завершилось неудачно.

Замечание:

На некоторых платформах, непрерывная память является дорогим ресурсом и минимальная выделяемая длина может совпадать с размером страницы, вы должны постараться объединить все Ваши запросы на непрерывную память, насколько это возможно. Простейшим способом добиться этого является использование вызова dma_pool (см. ниже).

Параметр flag ( только для (dma_alloc_coherent) позволяет вызывающей программе задавать GFP_ flags (для kmalloc) для правильного выделения (реализация может игнорировать этот флаги, которые определяют выделение памяти, подобно GFP_DMA). При вызове pci_alloc_consistent Вы должны предполагать использование поведения GFP_ATOMIC.

void
dma_free_coherent(struct device *dev, size_t size, void *cpu_addr,
			   dma_addr_t dma_handle)
void
pci_free_consistent(struct pci_dev *dev, size_t size, void *cpu_addr,
			   dma_addr_t dma_handle)

Осовобождает ранее выделенный регион непрерывной памяти Параметры dev, siaze и dma_handle обязательно должны быть теми же самыми, что использовались при выделении этого региона. cpu_addr must быть виртуальным адресом полученным при распределении непрерывной памяти.

Заметим, что в отличие от вызовов родственных функций выделения памяти, эти подпрограммы могут быть вызваны только при разрешонных IRQ.

Часть Ib - Использование небольшого dma- когерентного буфера

Для получения доступа к этой части dma_ API, Вы должны включить #include <linux/dmapool.h>

Многие драйверы нуждаются в множестве небольших dma-когерентных регионов, для описателей DMA и буферов В/В.Вместо того, что бы выделять память в единицах страниц, используя dma_alloc_coherent(), Вы можете использовать пул DMA. Он устроен подобно структуре kmem_cache, исключением того, что он использует dma-когерентный аллокатор, а не __get_free_pages(). Кроме того, он учитывает общие проблемы аппаратуры по выравниванию, подобные тому, что голова очереди должнв быть выравнена на N-байт.

	struct dma_pool *
	dma_pool_create(const char *name, struct device *dev,
			size_t size, size_t align, size_t alloc);

	struct pci_pool *
	pci_pool_create(const char *name, struct pci_device *dev,
			size_t size, size_t align, size_t alloc);

Подпрограммы pool create() инициализируют пул DMA-когерентных буферов, для использования с заданным устройством. Они могут вызываться только в конетексте, который может засыпать.

Параметр name используется для целей диагностики (подобно stuct kmem_cache name); параемтры dev и size подобны аналогичным параметрам вызова dma_alloc_coherent(). Аппаратные требования устройства по выравниванию должны учитываться в значении параметра "align" (который выражается в байтах и должен быть стенью двух). Если Ваше устройство не имеет ограничений на выравнивание блоков, задайте этот параметр равным нулю для alloc; значение 4096 говорит о том, начиная с этой точки, память должна выделяться блоками, не пересекающими границы в 4К.

	void *dma_pool_alloc(struct dma_pool *pool, gfp_t gfp_flags,
			dma_addr_t *dma_handle);

	void *pci_pool_alloc(struct pci_pool *pool, gfp_t gfp_flags,
			dma_addr_t *dma_handle);

Выделяет память из пула; предоставленная память будет соответствовать требованиям по размеру и выравниванию, заданным во время создания. Задавайте флаг GFP_ATOMIC для предотвращения блокировки, или, если это разрешено, (не в обработчике прерываний и не в SMP блокировке) задавайте флаг GFP_KERNEL. Подобно dma_alloc_coherent(), эта функция возвращает два значения : адрес, используемый ЦП и dma адрес, используемый в пуле устройства.

	void dma_pool_free(struct dma_pool *pool, void *vaddr,
			dma_addr_t addr);

	void pci_pool_free(struct pci_pool *pool, void *vaddr,
			dma_addr_t addr);

Возвращает блок памяти в пул. Параметр pool должен иметь то же самое значение, которое было использовано при вызове выделения памяти; адрес в ЦП (vaddr) и DMA адрес должны иметь те значения, которые были получены при вызове подпрограммы выделения памяти в тот момент, когда она завершила свою работу.

	void dma_pool_destroy(struct dma_pool *pool);

	void pci_pool_destroy(struct pci_pool *pool);

Эта подпрограмма освобождает ресурсы пула. Она может быть вызвана только в конетексте, в котором возможно засыпание. Убедитесь в том, что Вы вернули всю выделенную память обратно в пул, до того, как разрушите его.

Часть Ic - Ограничения адресации DMA

int
dma_supported(struct device *dev, u64 mask)
int
pci_dma_supported(struct pci_dev *hwdev, u64 mask)

Проверяет, может ли устройство поддерживать DMA к памяти, описанной mask.

Возвращает: 1 если да и 0, если устройство не поддерживает DMA к этой памяти.

Замечание:

На самом деле, эта подпрограмма всего лишь проверяет, возможна ли такая маска. Она не меняет текущие утановки маски. Предполагается. что она является частью внутреннего API для использования на платформах, на которых внешнее API предназанчено для разработки драйверов.

int
dma_set_mask(struct device *dev, u64 mask)
int
pci_set_dma_mask(struct pci_device *dev, u64 mask)

Проверяет маску на допустимость и, если это так, обновляет параметры устройства.

Возвращает: 0 при успехе и отрицательное значение при неудаче..

u64
dma_get_required_mask(struct device *dev)

Возвращает маску, которая требуется платформе для эффективной работы. Обычно это подразумевает, что возвращается маска, минимально требуемая для покрытия всей памяти. Проверка затребованной маски позволяет драйверу с переменным размером дескрипторов возможность использовать, при необходимости, дескрипторы меньшего размера.

Запрос требуемой маски не изменяет текущую маску. Если Вы желаете использовать эти преимущества, Вы должны выполнить dma_set_mask() для того, что бы установить маску в полученное значение.

Часть Id - Потоковое мапирование DMA

dma_addr_t
dma_map_single(struct device *dev, void *cpu_addr, size_t size,
		      enum dma_data_direction direction)
dma_addr_t
pci_map_single(struct pci_dev *hwdev, void *cpu_addr, size_t size,
		      int direction)

Мапирует слой виртуальной памяти процессора так, что он становится доступным устройству и возвращает физический указатель на эту память.

Направление обоих вызовов API можно легко изменить с помощью кастинга. Однако dma_ API использует точно определённый тип нумератора для указания направления:

DMA_NONE		= PCI_DMA_NONE		no direction (used for
						debugging)
DMA_TO_DEVICE		= PCI_DMA_TODEVICE	data is going from the
						memory to the device
DMA_FROM_DEVICE		= PCI_DMA_FROMDEVICE	data is coming from
						the device to the
						memory
DMA_BIDIRECTIONAL	= PCI_DMA_BIDIRECTIONAL	direction isn't known

Замечание:

Не все регионы памяти машины могут быть отмапированы этими вызовами API. Более того, регионы, которые выглядят физически последовательными в виртуальной памяти ядра, могут оказаться не последовательными в физической памяти. Так как это API не предоставляет никаких возможностей для работы со списком "рассеяния/сборки" то если пользователь попытается отмапировать физически не последовательные участки памяти, то это закончится неудачей. По этой причине, рекомендуется, что бы память, отмапированная этим API, была получена только из источника, гарантирующего её физическую непрерывность (подобно kmalloc) .

Более того, физический адрес памяти должен быть внутри dma_mask этого устройства (dma_mask представляет собой битовую маску диапазонов адресов устройства, то есть, если физический адрес памяти логически умноженный на dma_mask, в точности равен физическому адресу, то такое устройство может выполнять DMA к памяти). Для того, что бы убедиться в том, что память выделенная kmalloc находится внутри dma_mask, драйвер может определить различные флаги, зависящие от платформы для ограничения диапазона выделяемой физической памяти, (Например, на x86, флаг GFP_DMA гарантирует, что выделенная память находится внутри первых 16 Мб доступной физической памяти, как этого требую ISA устройства).

Заметим также, что ограничения на физическую смежность и dma_mask, упомянутые выше, становятся ненужными, если на платформе реализован механизм IOMMU (устройства могут мапировать виртуальные адреса на физические между шиной памяти ввода/вывода и устройством). Однако, для переносимости, драйвер устройства может не делать предположений о наличии IOMMU

Предупреждение

Операции синхронизации памяти выполняются порциями, называемыми шириной строки кэша. Для того, что бы выделение памяти в данном API работало правильно, регион должен начинаться в точности на границе строки кэша и заканчиваться в точности на ней же (для предотвращения мапирования двух отдельных регионов, разделяющих одну строку кэша). Так как размер строки кэша может быть неизвестен во время компилляции, API не требует этого делать. Более того, рекомендуется, что бы разработчик драйвера, который не озаботился определением размера строки кэша на этапе выполнеия программы, просто мапировал виртуальный регион, который начинается и заканчивается на границе страницы (что гарантирует совпадение с границами строки кэша).

Синхронизация DMA_TO_DEVICE должна выполняться после завершения модификации памяти программой но до того, как драйвер потеряет контроль над этим регионом памяти. Сразу же после того, как этот примитив был использован, память, которая в нём задана, должна трактоваться устройством как доступная только на чтение. Для того, что бы устройство могло писать в неё, она должна быть DMA_BIDIRECTIONAL (смотри ниже).

Синхронизация DMA_FROM_DEVICE должна быть выполена до начала доступа драйвера к данным, которые могли быть изменены устройством. Эта память должна трактоваться драйвером, как доступная только на чтение. Если драйверу необходимо писать в неё в любой момент, то она должна быть DMA_BIDIRECTIONAL (смотри ниже).

DMA_BIDIRECTIONAL особого управления: это означает, что драйвер не может быть уверен в том, что память не была модифицирована до того, как она была передана устройству и так же он не может быть уверен в том, что устройство не модифицировало эту память. Таким образом, Вы всегда должны синхронизировать эту память дважды: первый раз перед тем, как память будет передана устройству (для уверенности в том, что все изменения в памяти переданы процессором в память) и второй раз пере тем, как сделать данные доступными после их использования устройством (для уверенности в том, что все строки кэша процессора обновились в соответствии с данными, которые устройство могло изменить).

void
dma_unmap_single(struct device *dev, dma_addr_t dma_addr, size_t size,
		 enum dma_data_direction direction)
void
pci_unmap_single(struct pci_dev *hwdev, dma_addr_t dma_addr,
		 size_t size, int direction)

Освобождает регион, отмапированный ранее. Все входные параметры должны быть идентичны тем, которые были переданы (и вернулись, как результат) API мапирования.

dma_addr_t
dma_map_page(struct device *dev, struct page *page,
		    unsigned long offset, size_t size,
		    enum dma_data_direction direction)
dma_addr_t
pci_map_page(struct pci_dev *hwdev, struct page *page,
		    unsigned long offset, size_t size, int direction)
void
dma_unmap_page(struct device *dev, dma_addr_t dma_address, size_t size,
	       enum dma_data_direction direction)
void
pci_unmap_page(struct pci_dev *hwdev, dma_addr_t dma_address,
	       size_t size, int direction)

API для мапирования и размапирования страниц. Все замечания и предупреждения для других API мапирования, применимы и здесь. Кроме того, несмотря на то, что параметры offset и size для мапирования конкретных страниц, рекомендуется, что бы Вы никогда не использовали их, если Вы не знаете фактическую ширинну кэша.

int
dma_mapping_error(struct device *dev, dma_addr_t dma_addr)

int
pci_dma_mapping_error(struct pci_dev *hwdev, dma_addr_t dma_addr)

В некоторых ситуациях вызовы функций dma_map_single и dma_map_page будут завершаться неудачно при выполнении мапирования. Драйвер может проверить наличие ошибок, проверяя возвращённый dma адрес с помощью dma_mapping_error(). Если будет получено ненулевое значение, то означает, что мапирование выполнить невозможно и драйвер должен предпринять соответствующие действия (например - уменьшить использование dma мапирования или попытаться выполнить операцию спустя некоторое время).

	int
	dma_map_sg(struct device *dev, struct scatterlist *sg,
		int nents, enum dma_data_direction direction)
	int
	pci_map_sg(struct pci_dev *hwdev, struct scatterlist *sg,
		int nents, int direction)

Возвращает: количество отмапированных физических сегментов (Это значение может быть меньше, чем входное значение nents если некторые элементы списка "scatter/gather" физически, или виртуально смежны и тогда в карте IOMMU они отмапированы как целое).

Обратите внимание, что что sg не может использоваться для мапирования повторно. Процесс мапирования может разрушить информацию в sg.

Как и другие API для мапирования, dma_map_sg может завершиться неудачей. При возникновении ошибки возвращается 0 и драйвер должен предпринять соответствующие действия. Критически важно, что бы драйвер сделал бы что-то из возможного : блочный драйвер может отбросить запрос или даже сделать "oops", вместо ттого, что бы не делать ничего и разрушить файловую систему.

С помощью scatterlists, Вы можете использовать результаты мапирования следующим образом:

	int i, count = dma_map_sg(dev, sglist, nents, direction);
	struct scatterlist *sg;

	for_each_sg(sglist, sg, count, i) {
		hw_address[i] = sg_dma_address(sg);
		hw_len[i] = sg_dma_len(sg);
	}

где nents задаёт количество строк в таблице sglist.

Реализация может объединять несколько последовательных строк sglist в одну (например, с помощью IOMMU или если несколько страниц являются физически последоваельными) и возвращать и возвращать фактический номер строки sg на который мапированы эти страницы. Если мапирование завершилось неудачно, то возвращается 0.

После этого Вы должны выполнить цикл count раз (замечание: Возможно, что число повторений цикла будет меньше nents и использовать макросы sg_dma_address() и sg_dma_len() котрые Вы ранее использовали для доступа к accessed sg->address и sg->length, как показано выше.

	void
	dma_unmap_sg(struct device *dev, struct scatterlist *sg,
		int nhwentries, enum dma_data_direction direction)
	void
	pci_unmap_sg(struct pci_dev *hwdev, struct scatterlist *sg,
		int nents, int direction)

Отмена мапирования ранее отмапированного списка scatter/gather. Все параметры должны иметь те же самые значения, которые использовались при вызове API мапирования scatter/gather.

Замечание:

nents должно быть числом, котрое Вы передавали на вход API, а не физическим количеством строк.

void
dma_sync_single(struct device *dev, dma_addr_t dma_handle, size_t size,
		enum dma_data_direction direction)
void
pci_dma_sync_single(struct pci_dev *hwdev, dma_addr_t dma_handle,
			   size_t size, int direction)
void
dma_sync_sg(struct device *dev, struct scatterlist *sg, int nelems,
			  enum dma_data_direction direction)
void
pci_dma_sync_sg(struct pci_dev *hwdev, struct scatterlist *sg,
		       int nelems, int direction)

Синхронизовать единицу неперывного, или scatter/gather мапирования. Все параметры должны быть теми же, что при мапировании этой единицы.

Замечание: Вы должны делать это:

  • Перед чтением значения, которое было записано DMA устройства (используйте направление DMA_FROM_DEVICE)

  • После записи в устройство значения, которое записали через DMA (используйте направление DMA_TO_DEVICE)

  • До иemphasis> после передачи памяти устройству, если устройство является DMA_BIDIRECTIONAL

Смотри так же dma_map_single().

dma_addr_t
dma_map_single_attrs(struct device *dev, void *cpu_addr, size_t size,
		     enum dma_data_direction dir,
		     struct dma_attrs *attrs)

void
dma_unmap_single_attrs(struct device *dev, dma_addr_t dma_addr,
		       size_t size, enum dma_data_direction dir,
		       struct dma_attrs *attrs)

int
dma_map_sg_attrs(struct device *dev, struct scatterlist *sgl,
		 int nents, enum dma_data_direction dir,
		 struct dma_attrs *attrs)

void
dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sgl,
		   int nents, enum dma_data_direction dir,
		   struct dma_attrs *attrs)

Четыре вышеприведённые функции в точности совпадают со своими двойниками без суффикса _attrs, за исключением параметра struct dma_attrs*.

struct dma_attrs инкапсулирует "dma атрибуты". Определение этой структуры можно увидеть в linux/dma-attrs.h

Интерпретация атрибутов DMA зависит от архитектуры, и каждый атрибут должен быть документирован в Documentation/DMA-attributes.txt>.

Если указатель dma_attrs* равен NULL, то семантика всех этих функций совпадает с семантикой соответствующих функций без суффикса _attrs. Поэтому, обычно, вызов dma_map_single_attrs() может заменять вызов dma_map_single() и т.д.

В качестве примера использования функций *_attrs, здесь показано, как Вы должны передавать атрибут DMA_ATTR_FOO, когда мапируете память для DMA:

#include <linux/dma-attrs.h>
/* DMA_ATTR_FOO should be defined in linux/dma-attrs.h and
 * documented in Documentation/DMA-attributes.txt */
...

	DEFINE_DMA_ATTRS(attrs);
	dma_set_attr(DMA_ATTR_FOO, &attrs);
	....
	n = dma_map_sg_attrs(dev, sg, nents, DMA_TO_DEVICE, &attr);
	....

Те архитектуры, на которые влияет флаг DMA_ATTR_FOO, будут проверять его наличие в их реализации функций мапирования и размапирования, например так:

void whizco_dma_map_sg_attrs(struct device *dev, dma_addr_t dma_addr,
			     size_t size, enum dma_data_direction dir,
			     struct dma_attrs *attrs)
{
	....
	int foo =  dma_get_attr(DMA_ATTR_FOO, attrs);
	....
	if (foo)
		/* twizzle the frobnozzle */
	....

Часть II - Использование dma_ для продвинутых программистов

Предупреждение

Warning: These pieces of the DMA API have no PCI equivalent. They should also not be used in the majority of cases, since they cater for unlikely corner cases that don't belong in usual drivers.

If you don't understand how cache line coherency works between a processor and an I/O device, you should not be using this part of the API at all.

void *
dma_alloc_noncoherent(struct device *dev, size_t size,
			       dma_addr_t *dma_handle, gfp_t flag)

Identical to dma_alloc_coherent() except that the platform will choose to return either consistent or non-consistent memory as it sees fit. By using this API, you are guaranteeing to the platform that you have all the correct and necessary sync points for this memory in the driver should it choose to return non-consistent memory.

Note:

where the platform can return consistent memory, it will guarantee that the sync points become nops.

Warning: Handling non-consistent memory is a real pain. You should only ever use this API if you positively know your driver will be required to work on one of the rare (usually non-PCI) architectures that simply cannot make consistent memory.

void
dma_free_noncoherent(struct device *dev, size_t size, void *cpu_addr,
			      dma_addr_t dma_handle)

Free memory allocated by the nonconsistent API. All parameters must be identical to those passed in (and returned by dma_alloc_noncoherent()).

int
dma_is_consistent(struct device *dev, dma_addr_t dma_handle)

Returns true if the device dev is performing consistent DMA on the memory
area pointed to by the dma_handle.

int
dma_get_cache_alignment(void)

Returns the processor cache alignment. This is the absolute minimum alignment *and* width that you must observe when either mapping memory or doing partial flushes.

Notes: This API may return a number *larger* than the actual cache line, but it will guarantee that one or more cache lines fit exactly into the width returned by this call. It will also always be a power of two for easy alignment.

void
dma_sync_single_range(struct device *dev, dma_addr_t dma_handle,
		      unsigned long offset, size_t size,
		      enum dma_data_direction direction)

Does a partial sync, starting at offset and continuing for size. You must be careful to observe the cache alignment and width when doing anything like this. You must also be extra careful about accessing memory you intend to sync partially.

void
dma_cache_sync(struct device *dev, void *vaddr, size_t size,
	       enum dma_data_direction direction)

Do a partial sync of memory that was allocated by dma_alloc_noncoherent(), starting at virtual address vaddr and continuing on for size. Again, you *must* observe the cache line boundaries when doing this.

int
dma_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
			    dma_addr_t device_addr, size_t size, int
			    flags)

Declare region of memory to be handed out by dma_alloc_coherent when it's asked for coherent memory for this device.

bus_addr is the physical address to which the memory is currently assigned in the bus responding region (this will be used by the platform to perform the mapping).

device_addr is the physical address the device needs to be programmed with actually to address this memory (this will be handed out as the dma_addr_t in dma_alloc_coherent()).

size is the size of the area (must be multiples of PAGE_SIZE).

flags can be or'd together and are:

DMA_MEMORY_MAP - request that the memory returned from dma_alloc_coherent() be directly writable. DMA_MEMORY_IO - request that the memory returned from dma_alloc_coherent() be addressable using read/write/memcpy_toio etc. One or both of these flags must be present. DMA_MEMORY_INCLUDES_CHILDREN - make the declared memory be allocated by dma_alloc_coherent of any child devices of this one (for memory residing on a bridge).

DMA_MEMORY_EXCLUSIVE - only allocate memory from the declared regions. Do not allow dma_alloc_coherent() to fall back to system memory when it's out of memory in the declared region.

The return value will be either DMA_MEMORY_MAP or DMA_MEMORY_IO and must correspond to a passed in flag (i.e. no returning DMA_MEMORY_IO if only DMA_MEMORY_MAP were passed in) for success or zero for failure.

Note, for DMA_MEMORY_IO returns, all subsequent memory returned by dma_alloc_coherent() may no longer be accessed directly, but instead must be accessed using the correct bus functions. If your driver isn't prepared to handle this contingency, it should not specify DMA_MEMORY_IO in the input flags.

As a simplification for the platforms, only *one* such region of memory may be declared per device.

For reasons of efficiency, most platforms choose to track the declared region only at the granularity of a page. For smaller allocations, you should use the dma_pool() API.

void
dma_release_declared_memory(struct device *dev)

Remove the memory region previously declared from the system. This API performs *no* in-use checking for this region and will return unconditionally having removed all the required structures. It is the driver's job to ensure that no parts of this memory region are currently in use.

void *
dma_mark_declared_memory_occupied(struct device *dev,
				  dma_addr_t device_addr, size_t size)

This is used to occupy specific regions of the declared space (dma_alloc_coherent() will hand out the first free region it finds).

device_addr is the *device* address of the region requested.

size is the size (and should be a page-sized multiple).

The return value will be either a pointer to the processor virtual address of the memory, or an error (via PTR_ERR()) if any part of the region is occupied.

Часть III - Отладка драйвера, используя DMA-API

The DMA-API as described above as some constraints. DMA addresses must be released with the corresponding function with the same size for example. With the advent of hardware IOMMUs it becomes more and more important that drivers do not violate those constraints. In the worst case such a violation can result in data corruption up to destroyed filesystems.

To debug drivers and find bugs in the usage of the DMA-API checking code can be compiled into the kernel which will tell the developer about those violations. If your architecture supports it you can select the "Enable debugging of DMA-API usage" option in your kernel configuration. Enabling this option has a performance impact. Do not enable it in production kernels.

If you boot the resulting kernel will contain code which does some bookkeeping about what DMA memory was allocated for which device. If this code detects an error it prints a warning message with some details into your kernel log. An example warning message may look like this:

------------[ cut here ]------------
WARNING: at /data2/repos/linux-2.6-iommu/lib/dma-debug.c:448
	check_unmap+0x203/0x490()
Hardware name:
forcedeth 0000:00:08.0: DMA-API: device driver frees DMA memory with wrong
	function [device address=0x00000000640444be] [size=66 bytes] [mapped as
single] [unmapped as page]
Modules linked in: nfsd exportfs bridge stp llc r8169
Pid: 0, comm: swapper Tainted: G        W  2.6.28-dmatest-09289-g8bb99c0 #1
Call Trace:
 <IRQ>  [<ffffffff8024b22>] warn_slowpath+0xf2/0x130
 [<ffffffff8064b70>] _spin_unlock+0x10/0x30
 [<ffffffff80537e7>] usb_hcd_link_urb_to_ep+0x75/0xc0
 [<ffffffff8064c22>] _spin_unlock_irqrestore+0x12/0x40
 [<ffffffff805547f>] ohci_urb_enqueue+0x19f/0x7c0
 [<ffffffff8025f96>] queue_work+0x56/0x60
 [<ffffffff8023e10>] enqueue_task_fair+0x20/0x50
 [<ffffffff8053279>] usb_hcd_submit_urb+0x379/0xbc0
 [<ffffffff803b8c3>] cpumask_next_and+0x23/0x40
 [<ffffffff8023177>] find_busiest_group+0x207/0x8a0
 [<ffffffff806484f>] _spin_lock_irqsave+0x1f/0x50
 [<ffffffff803cea3>] check_unmap+0x203/0x490
 [<ffffffff803c259>] debug_dma_unmap_page+0x49/0x50
 [<ffffffff8048f26>] nv_tx_done_optimized+0xc6/0x2c0
 [<ffffffff8048c13>] nv_nic_irq_optimized+0x73/0x2b0
 [<ffffffff8026df84>] handle_IRQ_event+0x34/0x70
 [<ffffffff8026ffe9>] handle_edge_irq+0xc9/0x150
 [<ffffffff8020e3ab>] do_IRQ+0xcb/0x1c0
 [<ffffffff8020c093>] ret_from_intr+0x0/0xa
 <EOI> <4>---[ end trace f6435a98e2a38c0e ]---

The driver developer can find the driver and the device including a stacktrace of the DMA-API call which caused this warning.

Per default only the first error will result in a warning message. All other errors will only silently counted. This limitation exist to prevent the code from flooding your kernel log. To support debugging a device driver this can be disabled via debugfs. See the debugfs interface documentation below for details.

The debugfs directory for the DMA-API debugging code is called dma-api/. In this directory the following files can currently be found:

	dma-api/all_errors	This file contains a numeric value. If this
				value is not equal to zero the debugging code
				will print a warning for every error it finds
				into the kernel log. Be careful with this
				option, as it can easily flood your logs.

	dma-api/disabled	This read-only file contains the character 'Y'
				if the debugging code is disabled. This can
				happen when it runs out of memory or if it was
				disabled at boot time

	dma-api/error_count	This file is read-only and shows the total
				numbers of errors found.

	dma-api/num_errors	The number in this file shows how many
				warnings will be printed to the kernel log
				before it stops. This number is initialized to
				one at system boot and be set by writing into
				this file

	dma-api/min_free_entries
				This read-only file can be read to get the
				minimum number of free dma_debug_entries the
				allocator has ever seen. If this value goes
				down to zero the code will disable itself
				because it is not longer reliable.

	dma-api/num_free_entries
				The current number of free dma_debug_entries
				in the allocator.

	dma-api/driver-filter
				You can write a name of a driver into this file
				to limit the debug output to requests from that
				particular driver. Write an empty string to
				that file to disable the filter and see
				all errors again.

If you have this code compiled into your kernel it will be enabled by default. If you want to boot without the bookkeeping anyway you can provide 'dma_debug=off' as a boot parameter. This will disable DMA-API debugging. Notice that you can not enable it again at runtime. You have to reboot to do so.

If you want to see debug messages only for a special device driver you can specify the dma_debug_driver=<drivername> parameter. This will enable the driver filter at boot time. The debug code will only print errors for that driver afterwards. This filter can be disabled or changed later using debugfs.

When the code disables itself at runtime this is most likely because it ran out of dma_debug_entries. These entries are preallocated at boot. The number of preallocated entries is defined per architecture. If it is too low for you boot with 'dma_debug_entries=<your_desired_number>' to overwrite the architectural default.