The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
kfifo_peek_len – gets the size of the next fifo record Synopsis kfifo_peek_len(fifo); Arguments fifo address of the fifo to be used Description This function returns the size of the next fifo record in number of bytes. Copyright
kfifo_peek – get data from the fifo without removing Synopsis kfifo_peek(fifo, val); Arguments fifo address of the fifo to be used val address where to store the data Description This reads the data from the fifo without removing it from the fifo. It returns 0 if the fifo was empty. Otherwise it returns the number…
kfifo_out_spinlocked – get data from the fifo using a spinlock for locking Synopsis kfifo_out_spinlocked(fifo, buf, n, lock); Arguments fifo address of the fifo to be used buf pointer to the storage buffer n max. number of elements to get lock pointer to the spinlock to use for locking Description This macro get the data from…
kfifo_out_peek – gets some data from the fifo Synopsis kfifo_out_peek(fifo, buf, n); Arguments fifo address of the fifo to be used buf pointer to the storage buffer n max. number of elements to get Description This macro get the data from the fifo and return the numbers of elements copied. The data is not removed…
kfifo_out – get data from the fifo Synopsis kfifo_out(fifo, buf, n); Arguments fifo address of the fifo to be used buf pointer to the storage buffer n max. number of elements to get Description This macro get some data from the fifo and return the numbers of elements copied. Note that with only one concurrent…
kfifo_len – returns the number of used elements in the fifo Synopsis kfifo_len(fifo); Arguments fifo address of the fifo to be used Copyright
kfifo_is_full – returns true if the fifo is full Synopsis kfifo_is_full(fifo); Arguments fifo address of the fifo to be used Copyright
kfifo_is_empty – returns true if the fifo is empty Synopsis kfifo_is_empty(fifo); Arguments fifo address of the fifo to be used Copyright
kfifo_initialized – Check if the fifo is initialized Synopsis kfifo_initialized(fifo); Arguments fifo address of the fifo to check Description Return true if fifo is initialized, otherwise false. Assumes the fifo was 0 before. Copyright
kfifo_init – initialize a fifo using a preallocated buffer Synopsis kfifo_init(fifo, buffer, size); Arguments fifo the fifo to assign the buffer buffer the preallocated buffer to be used size the size of the internal buffer, this have to be a power of 2 Description This macro initialize a fifo using a preallocated buffer. The numer…
kfifo_in_spinlocked – put data into the fifo using a spinlock for locking Synopsis kfifo_in_spinlocked(fifo, buf, n, lock); Arguments fifo address of the fifo to be used buf the data to be added n number of elements to be added lock pointer to the spinlock to use for locking Description This macro copies the given values…
kfifo_in – put data into the fifo Synopsis kfifo_in(fifo, buf, n); Arguments fifo address of the fifo to be used buf the data to be added n number of elements to be added Description This macro copies the given buffer into the fifo and returns the number of copied elements. Note that with only one…
kfifo_get – get data from the fifo Synopsis kfifo_get(fifo, val); Arguments fifo address of the fifo to be used val address where to store the data Description This macro reads the data from the fifo. It returns 0 if the fifo was empty. Otherwise it returns the number processed elements. Note that with only one…
kfifo_from_user – puts some data from user space into the fifo Synopsis kfifo_from_user(fifo, from, len, copied); Arguments fifo address of the fifo to be used from pointer to the data to be added len the length of the data to be added copied pointer to output variable to store the number of copied bytes Description…
kfifo_free – frees the fifo Synopsis kfifo_free(fifo); Arguments fifo the fifo to be freed Copyright
kfifo_esize – returns the size of the element managed by the fifo Synopsis kfifo_esize(fifo); Arguments fifo address of the fifo to be used Copyright
kfifo_dma_out_prepare – setup a scatterlist for DMA output Synopsis kfifo_dma_out_prepare(fifo, sgl, nents, len); Arguments fifo address of the fifo to be used sgl pointer to the scatterlist array nents number of entries in the scatterlist array len number of elements to transfer Description This macro fills a scatterlist for DMA output which at most len…
kfifo_dma_out_finish – finish a DMA OUT operation Synopsis kfifo_dma_out_finish(fifo, len); Arguments fifo address of the fifo to be used len number of bytes transferred Description This macro finish a DMA OUT operation. The out counter will be updated by the len parameter. No error checking will be done. Note that with only one concurrent reader…
kfifo_dma_in_prepare – setup a scatterlist for DMA input Synopsis kfifo_dma_in_prepare(fifo, sgl, nents, len); Arguments fifo address of the fifo to be used sgl pointer to the scatterlist array nents number of entries in the scatterlist array len number of elements to transfer Description This macro fills a scatterlist for DMA input. It returns the number…
kfifo_dma_in_finish – finish a DMA IN operation Synopsis kfifo_dma_in_finish(fifo, len); Arguments fifo address of the fifo to be used len number of bytes to received Description This macro finish a DMA IN operation. The in counter will be updated by the len parameter. No error checking will be done. Note that with only one concurrent…