diff --git a/Documentation/reference/os/iob.rst b/Documentation/reference/os/iob.rst index 3d0f667a1c5..8996ca159b3 100644 --- a/Documentation/reference/os/iob.rst +++ b/Documentation/reference/os/iob.rst @@ -163,6 +163,7 @@ Public Function Prototypes - :c:func:`iob_tryadd_queue()` - :c:func:`iob_remove_queue()` - :c:func:`iob_peek_queue()` + - :c:func:`iob_free_queue()` - :c:func:`iob_destroy_queue()` - :c:func:`iob_copyin()` - :c:func:`iob_trycopyin()` @@ -231,6 +232,10 @@ Public Function Prototypes :return: Returns a reference to the I/O buffer chain at the head of the queue. +.. c:function:: void iob_free_queue(FAR struct iob_s *iob, FAR struct iob_queue_s *iobq); + + Free an entire queue of I/O buffer chains. + .. c:function:: void iob_destroy_queue(FAR struct iob_queue_s *qhead); Destroy all I/O buffer chains from the iob queue. diff --git a/include/nuttx/mm/iob.h b/include/nuttx/mm/iob.h index 191cd75067c..31bbf06cfc1 100644 --- a/include/nuttx/mm/iob.h +++ b/include/nuttx/mm/iob.h @@ -427,6 +427,19 @@ FAR struct iob_s *iob_remove_queue(FAR struct iob_queue_s *iobq); FAR struct iob_s *iob_peek_queue(FAR struct iob_queue_s *iobq); #endif +/**************************************************************************** + * Name: iob_free_queue + * + * Description: + * Free an entire queue of I/O buffer chains. + * + ****************************************************************************/ + +#if CONFIG_IOB_NCHAINS > 0 +void iob_free_queue(FAR struct iob_s *iob, FAR struct iob_queue_s *iobq, + enum iob_user_e producerid); +#endif /* CONFIG_IOB_NCHAINS > 0 */ + /**************************************************************************** * Name: iob_destroy_queue * diff --git a/mm/iob/iob_free_queue.c b/mm/iob/iob_free_queue.c new file mode 100644 index 00000000000..2753d5d2d67 --- /dev/null +++ b/mm/iob/iob_free_queue.c @@ -0,0 +1,93 @@ +/**************************************************************************** + * mm/iob/iob_free_queue.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include +#include +#include + +#include "iob.h" + +#if CONFIG_IOB_NCHAINS > 0 + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +#ifndef NULL +# define NULL ((FAR void *)0) +#endif + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Name: iob_free_queue + * + * Description: + * Free an entire queue of I/O buffer chains. + * + ****************************************************************************/ + +void iob_free_queue(FAR struct iob_s *iob, FAR struct iob_queue_s *iobq, + enum iob_user_e producerid) +{ + FAR struct iob_qentry_s *prev = NULL; + FAR struct iob_qentry_s *qentry; + + for (qentry = iobq->qh_head; qentry != NULL; + prev = qentry, qentry = qentry->qe_flink) + { + /* Find head of the I/O buffer chain */ + + if (qentry->qe_head == iob) + { + if (prev == NULL) + { + iobq->qh_head = qentry->qe_flink; + } + else + { + prev->qe_flink = qentry->qe_flink; + } + + if (iobq->qh_tail == qentry) + { + iobq->qh_tail = prev; + } + + /* Remove the queue container */ + + iob_free_qentry(qentry); + + /* Free the I/O chain */ + + iob_free_chain(iob, producerid); + + break; + } + } +} + +#endif /* CONFIG_IOB_NCHAINS > 0 */