xQueueCreate() function in FreeRTOS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the xQueueCreate() function in FreeRTOS?

The xQueueCreate() function creates a new queue that can hold a fixed number of items, each of a fixed size. It is used to pass data safely between tasks or between interrupts and tasks.

beginner

What are the two main parameters of xQueueCreate()?

The two main parameters are:
1. uxQueueLength: The maximum number of items the queue can hold.
2. uxItemSize: The size in bytes of each item stored in the queue.

beginner

What does xQueueCreate() return if the queue creation is successful?

It returns a handle to the created queue, which is used in other queue API functions to reference this queue.

intermediate

What happens if xQueueCreate() fails to create a queue?

If the queue cannot be created (for example, due to insufficient memory), xQueueCreate() returns NULL.

intermediate

Why is it important to specify the item size correctly when using xQueueCreate()?

Because the queue stores copies of items, specifying the correct item size ensures that the entire data item is copied and retrieved correctly. If the size is too small, data may be truncated; if too large, memory is wasted.

What does the uxQueueLength parameter specify in xQueueCreate()?

A The size of each item in bytes

B The timeout for queue operations

C The priority of the queue

D The maximum number of items the queue can hold

The uxQueueLength parameter sets how many items the queue can hold at once.

What is returned by xQueueCreate() if the queue is created successfully?

A An error code

B NULL

C A queue handle

D The size of the queue

A handle to the queue is returned to be used in other queue functions.

If xQueueCreate() returns NULL, what does it mean?

A Queue creation failed due to insufficient memory

B Queue was created successfully

C The queue is empty

D The queue is full

NULL indicates failure to create the queue, often due to lack of memory.

Why must the uxItemSize parameter be set correctly?

A To define the queue timeout

B To ensure the entire data item is copied into the queue

C To specify the number of items in the queue

D To set the queue priority

The item size tells the queue how many bytes to copy for each item.

Which of the following is NOT a use of xQueueCreate()?

A Creating a queue to store task priorities

B Creating a queue for passing data from interrupts to tasks

C Creating a queue for inter-task communication

D Creating a queue to hold fixed-size data items

Queues do not store task priorities; they store data items for communication.

Explain how to use xQueueCreate() to create a queue and what each parameter means.

Think about how you set the size and capacity of a mailbox to hold letters.

Describe what happens if xQueueCreate() fails and how you can detect this in your code.

Consider what you do if you try to open a mailbox but it doesn't exist.

Practice

1. What does the xQueueCreate() function do in FreeRTOS?

easy

A. Sends data to a queue

B. Creates a new queue to hold data items between tasks

C. Deletes an existing queue

D. Receives data from a queue

Solution

1. Step 1: Understand the purpose of xQueueCreate()

   The function is designed to create a new queue in FreeRTOS for inter-task communication.

2. Step 2: Differentiate from other queue functions

   Functions like sending or receiving data operate on existing queues, not create them.

3. Final Answer:

   Creates a new queue to hold data items between tasks -> Option B

4. Quick Check:

   xQueueCreate() = create queue [OK]

Hint: xQueueCreate() always makes a new queue [OK]

Common Mistakes:

• Confusing creation with sending or receiving data
• Thinking it deletes a queue
• Assuming it initializes queue data

2. Which of the following is the correct syntax to create a queue for 10 items, each of size sizeof(int)?

easy

A. xQueueCreate(10, sizeof(int));

B. xQueueCreate(sizeof(int), 10);

C. xQueueCreate(10);

D. xQueueCreate(sizeof(int));

Solution

1. Step 1: Recall xQueueCreate() parameters

   The first parameter is the number of items, the second is the size of each item.

2. Step 2: Match parameters to options

   xQueueCreate(10, sizeof(int)); correctly uses 10 items and sizeof(int) as size per item.

3. Final Answer:

   xQueueCreate(10, sizeof(int)); -> Option A

4. Quick Check:

   Parameters = (number, size) [OK]

Hint: First param = count, second = size [OK]

Common Mistakes:

• Swapping the order of parameters
• Providing only one parameter
• Using raw numbers instead of sizeof()

3. Consider this code snippet:

QueueHandle_t q = xQueueCreate(5, sizeof(char));
if (q == NULL) {
    printf("Queue creation failed\n");
} else {
    printf("Queue created successfully\n");
}

What will be printed if the queue is created successfully?

medium

A. Queue creation failed

B. Compilation error

C. Queue created successfully

D. No output

Solution

1. Step 1: Check the return value of xQueueCreate()

   If queue creation succeeds, it returns a non-NULL handle.

2. Step 2: Analyze the if condition

   The code prints "Queue created successfully" when q is not NULL.

3. Final Answer:

   Queue created successfully -> Option C

4. Quick Check:

   q != NULL means success [OK]

Hint: Check if queue handle is NULL for failure [OK]

Common Mistakes:

• Assuming NULL means success
• Ignoring the if condition
• Confusing print messages

4. What is wrong with this code?

QueueHandle_t q = xQueueCreate(0, sizeof(int));
if (q == NULL) {
    // handle error
}

medium

A. Queue size cannot be zero, so creation fails

B. sizeof(int) is invalid parameter

C. Missing queue deletion after creation

D. QueueHandle_t is not the correct type

Solution

1. Step 1: Understand queue length parameter

   The first parameter must be greater than zero to hold items.

2. Step 2: Consequence of zero length

   Passing zero causes xQueueCreate() to fail and return NULL.

3. Final Answer:

   Queue size cannot be zero, so creation fails -> Option A

4. Quick Check:

   Queue length > 0 required [OK]

Hint: Queue length must be > 0 [OK]

Common Mistakes:

• Using zero length queue
• Confusing size of item with queue length
• Ignoring return NULL check

5. You want to create a queue that can hold 3 structures of type SensorData. Which is the correct way to create this queue?

hard

A. xQueueCreate(1, sizeof(SensorData) * 3);

B. xQueueCreate(sizeof(SensorData), 3);

C. xQueueCreate(3, sizeof(SensorData*));

D. xQueueCreate(3, sizeof(SensorData));

Solution

1. Step 1: Identify queue length and item size

   Queue length is 3, item size is size of one SensorData structure.

2. Step 2: Match parameters to xQueueCreate()

   First parameter is number of items (3), second is size of each item (sizeof(SensorData)).

3. Final Answer:

   xQueueCreate(3, sizeof(SensorData)); -> Option D

4. Quick Check:

   Length=3, size=sizeof(struct) [OK]

Hint: Length first, size of one item second [OK]

Common Mistakes:

• Swapping length and size parameters
• Using pointer size instead of struct size
• Creating queue for one large combined item