Add to the existing CDC Class Driver's CreateStream() function documentation to explicitly state that the created streams are bidirectional.
This commit is contained in:
		
							parent
							
								
									958d28d05d
								
							
						
					
					
						commit
						414b92e812
					
				
					 4 changed files with 7 additions and 9 deletions
				
			
		| 
						 | 
					@ -690,11 +690,7 @@ static void ProcessReadCommand(void)
 | 
				
			||||||
	uint8_t DataIndexToRead = SentCommand.Data[1];
 | 
						uint8_t DataIndexToRead = SentCommand.Data[1];
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	if (IS_ONEBYTE_COMMAND(SentCommand.Data, 0x00))                         // Read bootloader info
 | 
						if (IS_ONEBYTE_COMMAND(SentCommand.Data, 0x00))                         // Read bootloader info
 | 
				
			||||||
	{
 | 
						  ResponseByte = BootloaderInfo[DataIndexToRead];
 | 
				
			||||||
		ResponseByte = BootloaderInfo[DataIndexToRead];
 | 
					 | 
				
			||||||
	}
 | 
					 | 
				
			||||||
	else if (IS_ONEBYTE_COMMAND(SentCommand.Data, 0x01))                    // Read signature byte
 | 
						else if (IS_ONEBYTE_COMMAND(SentCommand.Data, 0x01))                    // Read signature byte
 | 
				
			||||||
	{
 | 
						  ResponseByte = SignatureInfo[DataIndexToRead - 0x30];
 | 
				
			||||||
		ResponseByte = SignatureInfo[DataIndexToRead - 0x30];
 | 
					 | 
				
			||||||
	}
 | 
					 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -55,7 +55,7 @@
 | 
				
			||||||
		 *  can protect the AVR's firmware from being dumped from a secured AVR. When false, memory operations are
 | 
							 *  can protect the AVR's firmware from being dumped from a secured AVR. When false, memory operations are
 | 
				
			||||||
		 *  allowed at any time.
 | 
							 *  allowed at any time.
 | 
				
			||||||
		 */
 | 
							 */
 | 
				
			||||||
		#define SECURE_MODE           false
 | 
							#define SECURE_MODE              false
 | 
				
			||||||
 | 
					
 | 
				
			||||||
		/** Major bootloader version number. */
 | 
							/** Major bootloader version number. */
 | 
				
			||||||
		#define BOOTLOADER_VERSION_MINOR 2
 | 
							#define BOOTLOADER_VERSION_MINOR 2
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -212,7 +212,8 @@
 | 
				
			||||||
			void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 | 
								void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
			/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
 | 
								/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
 | 
				
			||||||
			 *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf).
 | 
								 *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
 | 
				
			||||||
 | 
								 *  stream is bidirectional and can be used for both input and output functions.
 | 
				
			||||||
			 *
 | 
								 *
 | 
				
			||||||
			 *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
 | 
								 *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
 | 
				
			||||||
			 *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
 | 
								 *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -215,7 +215,8 @@
 | 
				
			||||||
			uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 | 
								uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 | 
				
			||||||
			
 | 
								
 | 
				
			||||||
			/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
 | 
								/** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular
 | 
				
			||||||
			 *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf).
 | 
								 *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
 | 
				
			||||||
 | 
								 *  stream is bidirectional and can be used for both input and output functions.
 | 
				
			||||||
			 *
 | 
								 *
 | 
				
			||||||
			 *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
 | 
								 *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
 | 
				
			||||||
			 *        to the given CDC interface.
 | 
								 *        to the given CDC interface.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue