Add more include protection macros to give the user warnings when they try to manually include private driver header files, instead of the public driver headers.
This commit is contained in:
		
							parent
							
								
									3a2c1db675
								
							
						
					
					
						commit
						d49cc0f783
					
				
					 111 changed files with 341 additions and 85 deletions
				
			
		| 
						 | 
				
			
			@ -28,9 +28,11 @@
 | 
			
		|||
  this software.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_USB_DRIVER
 | 
			
		||||
#include "../../HighLevel/USBMode.h"
 | 
			
		||||
#if defined(USB_CAN_BE_DEVICE)
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_AUDIO_DRIVER
 | 
			
		||||
#include "Audio.h"
 | 
			
		||||
 | 
			
		||||
void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -55,6 +55,11 @@
 | 
			
		|||
			extern "C" {
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Preprocessor Checks: */
 | 
			
		||||
		#if !defined(__INCLUDE_FROM_AUDIO_DRIVER)
 | 
			
		||||
			#error Do not include this file directly. Include LUFA/Drivers/Class/Audio.h instead.
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Public Interface - May be used in end-application: */
 | 
			
		||||
		/* Type Defines: */		
 | 
			
		||||
			/** Class state structure. An instance of this structure should be made for each Audio interface
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -28,10 +28,12 @@
 | 
			
		|||
  this software.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_USB_DRIVER
 | 
			
		||||
#include "../../HighLevel/USBMode.h"
 | 
			
		||||
#if defined(USB_CAN_BE_DEVICE)
 | 
			
		||||
 | 
			
		||||
#define  INCLUDE_FROM_CDC_CLASS_DEVICE_C
 | 
			
		||||
#define  __INCLUDE_FROM_CDC_CLASS_DEVICE_C
 | 
			
		||||
#define  __INCLUDE_FROM_CDC_DRIVER
 | 
			
		||||
#include "CDC.h"
 | 
			
		||||
 | 
			
		||||
void CDC_Device_Event_Stub(void)
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -73,6 +73,11 @@
 | 
			
		|||
			extern "C" {
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Preprocessor Checks: */
 | 
			
		||||
		#if !defined(__INCLUDE_FROM_CDC_DRIVER)
 | 
			
		||||
			#error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.
 | 
			
		||||
		#endif
 | 
			
		||||
		
 | 
			
		||||
	/* Public Interface - May be used in end-application: */
 | 
			
		||||
		/* Type Defines: */
 | 
			
		||||
			/** Class state structure. An instance of this structure should be made for each CDC interface
 | 
			
		||||
| 
						 | 
				
			
			@ -281,7 +286,7 @@
 | 
			
		|||
	/* Private Interface - For use in library only: */
 | 
			
		||||
	#if !defined(__DOXYGEN__)
 | 
			
		||||
		/* Function Prototypes: */
 | 
			
		||||
			#if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)
 | 
			
		||||
			#if defined(__INCLUDE_FROM_CDC_CLASS_DEVICE_C)
 | 
			
		||||
				static int CDC_Device_putchar(char c, FILE* Stream);
 | 
			
		||||
				static int CDC_Device_getchar(FILE* Stream);
 | 
			
		||||
				static int CDC_Device_getchar_Blocking(FILE* Stream);
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -28,9 +28,11 @@
 | 
			
		|||
  this software.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_USB_DRIVER
 | 
			
		||||
#include "../../HighLevel/USBMode.h"
 | 
			
		||||
#if defined(USB_CAN_BE_DEVICE)
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_HID_DRIVER
 | 
			
		||||
#include "HID.h"
 | 
			
		||||
 | 
			
		||||
void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -55,6 +55,11 @@
 | 
			
		|||
			extern "C" {
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Preprocessor Checks: */
 | 
			
		||||
		#if !defined(__INCLUDE_FROM_HID_DRIVER)
 | 
			
		||||
			#error Do not include this file directly. Include LUFA/Drivers/Class/HID.h instead.
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Public Interface - May be used in end-application: */
 | 
			
		||||
		/* Type Defines: */
 | 
			
		||||
			/** Class state structure. An instance of this structure should be made for each HID interface
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -28,9 +28,11 @@
 | 
			
		|||
  this software.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_USB_DRIVER
 | 
			
		||||
#include "../../HighLevel/USBMode.h"
 | 
			
		||||
#if defined(USB_CAN_BE_DEVICE)
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_MIDI_DRIVER
 | 
			
		||||
#include "MIDI.h"
 | 
			
		||||
 | 
			
		||||
void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo)
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -47,7 +47,6 @@
 | 
			
		|||
	/* Includes: */
 | 
			
		||||
		#include "../../USB.h"
 | 
			
		||||
		#include "../Common/MIDI.h"
 | 
			
		||||
		#include "Audio.h"
 | 
			
		||||
 | 
			
		||||
		#include <string.h>
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -56,6 +55,11 @@
 | 
			
		|||
			extern "C" {
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Preprocessor Checks: */
 | 
			
		||||
		#if !defined(__INCLUDE_FROM_MIDI_DRIVER)
 | 
			
		||||
			#error Do not include this file directly. Include LUFA/Drivers/Class/MIDI.h instead.
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Public Interface - May be used in end-application: */
 | 
			
		||||
		/* Type Define: */
 | 
			
		||||
			/** Class state structure. An instance of this structure should be made for each MIDI interface
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -28,10 +28,12 @@
 | 
			
		|||
  this software.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_USB_DRIVER
 | 
			
		||||
#include "../../HighLevel/USBMode.h"
 | 
			
		||||
#if defined(USB_CAN_BE_DEVICE)
 | 
			
		||||
 | 
			
		||||
#define  INCLUDE_FROM_MS_CLASS_DEVICE_C
 | 
			
		||||
#define  __INCLUDE_FROM_MS_CLASS_DEVICE_C
 | 
			
		||||
#define  __INCLUDE_FROM_MS_DRIVER
 | 
			
		||||
#include "MassStorage.h"
 | 
			
		||||
 | 
			
		||||
static volatile bool* CallbackIsResetSource;
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -55,6 +55,11 @@
 | 
			
		|||
			extern "C" {
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Preprocessor Checks: */
 | 
			
		||||
		#if !defined(__INCLUDE_FROM_MS_DRIVER)
 | 
			
		||||
			#error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Public Interface - May be used in end-application: */
 | 
			
		||||
		/* Type Defines: */										
 | 
			
		||||
			/** Class state structure. An instance of this structure should be made for each Mass Storage interface
 | 
			
		||||
| 
						 | 
				
			
			@ -134,7 +139,7 @@
 | 
			
		|||
	/* Private Interface - For use in library only: */
 | 
			
		||||
	#if !defined(__DOXYGEN__)
 | 
			
		||||
		/* Function Prototypes: */
 | 
			
		||||
			#if defined(INCLUDE_FROM_MS_CLASS_DEVICE_C)
 | 
			
		||||
			#if defined(__INCLUDE_FROM_MS_CLASS_DEVICE_C)
 | 
			
		||||
				static void    MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 | 
			
		||||
				static bool    MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 | 
			
		||||
				static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -28,10 +28,12 @@
 | 
			
		|||
  this software.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
#define  __INCLUDE_FROM_USB_DRIVER
 | 
			
		||||
#include "../../HighLevel/USBMode.h"
 | 
			
		||||
#if defined(USB_CAN_BE_DEVICE)
 | 
			
		||||
 | 
			
		||||
#define  INCLUDE_FROM_RNDIS_CLASS_DEVICE_C
 | 
			
		||||
#define  __INCLUDE_FROM_RNDIS_CLASS_DEVICE_C
 | 
			
		||||
#define  __INCLUDE_FROM_RNDIS_DRIVER
 | 
			
		||||
#include "RNDIS.h"
 | 
			
		||||
 | 
			
		||||
static const uint32_t PROGMEM AdapterSupportedOIDList[]  =
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -55,6 +55,11 @@
 | 
			
		|||
			extern "C" {
 | 
			
		||||
		#endif
 | 
			
		||||
 | 
			
		||||
	/* Preprocessor Checks: */
 | 
			
		||||
		#if !defined(__INCLUDE_FROM_RNDIS_DRIVER)
 | 
			
		||||
			#error Do not include this file directly. Include LUFA/Drivers/Class/RNDIS.h instead.
 | 
			
		||||
		#endif
 | 
			
		||||
		
 | 
			
		||||
	/* Public Interface - May be used in end-application: */
 | 
			
		||||
		/* Type Defines: */					 
 | 
			
		||||
			/** Class state structure. An instance of this structure should be made for each RNDIS interface
 | 
			
		||||
| 
						 | 
				
			
			@ -131,7 +136,7 @@
 | 
			
		|||
	/* Private Interface - For use in library only: */
 | 
			
		||||
	#if !defined(__DOXYGEN__)
 | 
			
		||||
		/* Function Prototypes: */
 | 
			
		||||
		#if defined(INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)
 | 
			
		||||
		#if defined(__INCLUDE_FROM_RNDIS_CLASS_DEVICE_C)
 | 
			
		||||
			static void RNDIS_Device_ProcessRNDISControlMessage(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo)
 | 
			
		||||
			                                                    ATTR_NON_NULL_PTR_ARG(1);
 | 
			
		||||
			static bool RNDIS_Device_ProcessNDISQuery(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo, 
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue